Skip to content

Remove lightning- prefix from schemas/*.json and doc/*.md files#8038

Merged
rustyrussell merged 6 commits intoElementsProject:masterfrom
ShahanaFarooqui:doc-remove-lightning-prefix
Apr 15, 2025
Merged

Remove lightning- prefix from schemas/*.json and doc/*.md files#8038
rustyrussell merged 6 commits intoElementsProject:masterfrom
ShahanaFarooqui:doc-remove-lightning-prefix

Conversation

@ShahanaFarooqui
Copy link
Collaborator

@ShahanaFarooqui ShahanaFarooqui commented Jan 28, 2025

Changelog-Changed: Removed lightning- prefix from schemas/.json and doc/.md files.

@ShahanaFarooqui ShahanaFarooqui added this to the v25.02 milestone Jan 28, 2025
@ShahanaFarooqui ShahanaFarooqui force-pushed the doc-remove-lightning-prefix branch 5 times, most recently from 018866e to edcb906 Compare January 28, 2025 07:24
@ShahanaFarooqui ShahanaFarooqui marked this pull request as ready for review January 28, 2025 07:25
@ShahanaFarooqui ShahanaFarooqui changed the title Remove lightning- prefix from all schema *.json files Remove lightning- prefix from schemas/*.json and doc/*.md files Jan 28, 2025
@rustyrussell
Copy link
Contributor

Look like this broke sql plugin completely? Might have to be deferred until next release?

@ShahanaFarooqui ShahanaFarooqui modified the milestones: v25.02, v25.05 Feb 7, 2025
@ShahanaFarooqui ShahanaFarooqui force-pushed the doc-remove-lightning-prefix branch 4 times, most recently from 1878925 to 6bcc3ab Compare March 22, 2025 22:12
@ShahanaFarooqui ShahanaFarooqui force-pushed the doc-remove-lightning-prefix branch 6 times, most recently from 4532a08 to 314dddd Compare April 5, 2025 04:21
@ShahanaFarooqui
Copy link
Collaborator Author

@endothermicdev While fixing other schema mappings, I realized that reckless wasn't being generated from its corresponding JSON schema. I’ve added the logic to correctly map it and generate the markdown and manpage from the JSON. I tried to copy all relevant information from the markdown to the JSON, but please double-check the information for accuracy.

doc/wait.7 \
doc/waitsendpay.7 \
doc/withdraw.7 \
doc/xpay.7
Copy link
Contributor

Choose a reason for hiding this comment

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

The .7 pages still need the lightning- prefix, as otherwise names are too general, unfortunately.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is the list of markdown pages (*.md). We are later prefixing lightning- to this list for generating MANPAGES.

@ShahanaFarooqui ShahanaFarooqui force-pushed the doc-remove-lightning-prefix branch 2 times, most recently from 4b672bc to e065b30 Compare April 9, 2025 19:01
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is replacing the man page for the reckless tool with the schema conent (notes) for the plugin (which only passes through commands.) I think man page should still cover the tool, not the rpc access. We could add notes on reckless-rpc usage as well - I don't think there's enough content to warrant a second man page.

@rustyrussell rustyrussell force-pushed the doc-remove-lightning-prefix branch from e065b30 to 0d8c252 Compare April 15, 2025 01:46
@rustyrussell
Copy link
Contributor

Trivial rebase to fix flakes: we need to merge this ASAP to avoid merge hell.

@rustyrussell rustyrussell merged commit 9da6487 into ElementsProject:master Apr 15, 2025
39 of 40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants