KomodoPlatform / komodo-docs-mdx

Komodo Platform Docs
https://komodoplatform.com/en/docs/
2 stars 7 forks source link

Refactor structures #150

Closed smk762 closed 11 months ago

smk762 commented 11 months ago

Closes: https://github.com/KomodoPlatform/komodo-docs-mdx/issues/14

I've split the common structures into sections, as the doc was growing quite large (with more incoming from nft / hd branch PRs).

Beginning with legacy, I'll go thru all the method req/resp tables and refactor out the common objects into the appropriate section. Where the same structure is in use in more than one section, it will go in the index file in the root common_Structures folder.

github-actions[bot] commented 11 months ago

Preview for merge commit: 27e0d19, available on cloudflare at: https://ac5fb23e.komodo-docs.pages.dev/en/docs/

github-actions[bot] commented 11 months ago

Preview for merge commit: 487a9aa, available on cloudflare at: https://b9ce5b99.komodo-docs.pages.dev/en/docs/

github-actions[bot] commented 11 months ago

Preview for merge commit: 65055f4, available on cloudflare at: https://c5a376bd.komodo-docs.pages.dev/en/docs/

github-actions[bot] commented 11 months ago

Preview for merge commit: 8522a01, available on cloudflare at: https://90daee72.komodo-docs.pages.dev/en/docs/

github-actions[bot] commented 11 months ago

Preview for merge commit: f88b495, available on cloudflare at: https://0957ae70.komodo-docs.pages.dev/en/docs/

github-actions[bot] commented 11 months ago

Preview for merge commit: bc64623, available on cloudflare at: https://13bd8f47.komodo-docs.pages.dev/en/docs/

github-actions[bot] commented 11 months ago

Preview for merge commit: f4a021c, available on cloudflare at: https://59491d81.komodo-docs.pages.dev/en/docs/

github-actions[bot] commented 11 months ago

Preview for merge commit: 672c914, available on cloudflare at: https://20b38e1f.komodo-docs.pages.dev/en/docs/

smk762 commented 11 months ago

All methods scanned and refactored to use a common structure where applicable. Some methods with minor nested data remain unchanged where nested structure is not in common use. Most v2 dev methods (HD / task:: / etc) have been left as is for now. Those should be resolved in other open PRs and I can rescan the v2-dev methods after these are merged. Some dev comments have been added also for where more clarity or additional examples may be required.

For some common structures, examples in collapsible section have been added. This has not been done comprehensively, but should be addressed in a future PR (or incrementally as related updates are commited)

github-actions[bot] commented 11 months ago

Preview for merge commit: 6d416d5, available on cloudflare at: https://9f08c6f0.komodo-docs.pages.dev/en/docs/

github-actions[bot] commented 11 months ago

Preview for merge commit: 6d416d5, available on cloudflare at: https://6c6b30f7.komodo-docs.pages.dev/en/docs/

github-actions[bot] commented 11 months ago

Preview for merge commit: 19cc30c, available on cloudflare at: https://df5a4b67.komodo-docs.pages.dev/en/docs/