Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor docs #1239

Merged
merged 10 commits into from
Feb 12, 2022
Merged

Refactor docs #1239

merged 10 commits into from
Feb 12, 2022

Conversation

hunicus
Copy link
Contributor

@hunicus hunicus commented Feb 9, 2022

This PR is a redo of #1036, which was closed since it got out-of-date with the Liquid and Liquid testnet updates.

Benefits:

  • Move all endpoint data to one file to make updating and adding new endpoints less of a pain
  • Allow for descriptions that vary by network, which is a need I encountered when auditing docs for accuracy

Todo:

  • Audit docs for accuracy (this new structure makes that much easier)

I really wanted to get rid of a lot of the 'wrapper' functions, empty code sample items, and other things but those fixes weren't obvious to me so I leave them for future PRs. I think these changes at least make the docs more manageable for all involved and will allow me to get on with fixing higher-priority issues like accuracy, layout, etc.

@cla-bot cla-bot bot added the cla-signed label Feb 9, 2022
@softsimon softsimon self-requested a review February 10, 2022 13:26
Copy link
Member

@wiz wiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested ACK @ v2.4.0-dev [43e6045]
Everything seems to work exactly as is it did before, except the code is much cleaner :)

@wiz wiz merged commit 7e82967 into mempool:master Feb 12, 2022
@hunicus hunicus deleted the refactor-docs-2 branch March 24, 2022 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants