Skip to content

Update docs for march 2024 #316

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

Merged
merged 5 commits into from
Mar 24, 2024

Conversation

pinheadmz
Copy link
Contributor

@pinheadmz pinheadmz commented Mar 17, 2024

Currently includes basic cleanup of the markdown files and introduction page. Also updated a few RPC command help texts, revised scripts/apidocs.py and ran it.

TODO:

  • Add edge_schema.json and validate edges with it (important for LN channels)
  • Add a new script like apidocs.py that parses the schema files and automatically documents in graph.md including an example of all the <key attr.name=... headers that are needed in each graphml file
  • Add another script that parses the justfile and automatically documents those, maybe in a new kubernetes.md file
  • Finally, make sure our installation instructions are still accurate

@pinheadmz
Copy link
Contributor Author

marking as ready for now, will check installation and k8s docs in a future PR

@pinheadmz pinheadmz marked this pull request as ready for review March 24, 2024 15:33
@pinheadmz pinheadmz merged commit cc092de into bitcoin-dev-project:main Mar 24, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

1 participant