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

Add command module documentaiton generation tool #2285

Open
bcoles opened this issue Jan 24, 2022 · 3 comments
Open

Add command module documentaiton generation tool #2285

bcoles opened this issue Jan 24, 2022 · 3 comments

Comments

@bcoles
Copy link
Collaborator

bcoles commented Jan 24, 2022

Add a tool to the ./tools directory to automatically generate markdown content for the Command Modules page on the wiki.

Optionally also improve the format of the page. The data lends itself to a table format.

The format could be improved by including a link to the module source code in the repository and maybe also include the module description.

@DeezyE
Copy link
Contributor

DeezyE commented Jan 24, 2022

To keep the modules and wiki in sync? Yeah this is sorely needed.
Re the functionality, do you see this as something the maintainers would run whenever we saw a module updated?
I guess it could be part of the git Actions process also...

@bcoles
Copy link
Collaborator Author

bcoles commented Jan 25, 2022

To keep the modules and wiki in sync? Yeah this is sorely needed.

I want to eliminate pointless busy work. Using an automated tool will ensure formatting consistency.

Re the functionality, do you see this as something the maintainers would run whenever we saw a module updated? I guess it could be part of the git Actions process also...

It should be possible to automate wiki updates from workflows somehow (for commits to master only - not PRs).

Edit: One step at a time. Someone needs to write the tool first.

@DeezyE
Copy link
Contributor

DeezyE commented Jan 27, 2022

Edit: One step at a time. Someone needs to write the tool first.

Yes :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants