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

Lock values in documentation examples #7547

Open
2 of 3 tasks
ShahanaFarooqui opened this issue Aug 10, 2024 · 1 comment · May be fixed by #7756
Open
2 of 3 tasks

Lock values in documentation examples #7547

ShahanaFarooqui opened this issue Aug 10, 2024 · 1 comment · May be fixed by #7756
Assignees
Labels
docs Highlight - UX and Dev Experience Fit and finish to make higher layer devs joyous
Milestone

Comments

@ShahanaFarooqui
Copy link
Collaborator

ShahanaFarooqui commented Aug 10, 2024

With autogenerate example script, we are able to generate all rpc example but their values are not locked. So running this script will always change the doc/schemas/lightning-*.json's examples section. Temporarily developers can use REGENERATE='methodname1, methodname2' in command to re-generate a specific commands list.

  • Add all askrene examples (currently failing due to _ in the method name)
  • Lock all changing values (like port, timestamp, txid, payment_hash etc.)
  • Add CI action to auto generate all examples (it will add approx 5 more minutes in the CI execution)

Reference PR: #7457.

@ShahanaFarooqui
Copy link
Collaborator Author

We will not include askrene examples in this PR. These examples will be added once the RPCs are finalized and APIs are more stable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Highlight - UX and Dev Experience Fit and finish to make higher layer devs joyous
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant