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

Generate action documentation and automatically publish to wiki #528

Merged
merged 48 commits into from
Feb 24, 2025

Conversation

DnlLrssn
Copy link
Member

@DnlLrssn DnlLrssn commented Feb 20, 2025

Checklist

Squash commit message

  • Remove generation of settingup.md when running go generate
  • Move documentation on usage of tool to wiki
  • New commands to generate action and config documentation to wiki structure
  • New submodule with the wiki repo
  • Adds 2 new GitHub actions:
    • on commit to master: automatically publish new wiki (if needed)
    • on pr: verify documentation.go has been updated when needed

Info

Optional informative text (not to be included in commit message) relevant to reviewers.

@DnlLrssn DnlLrssn marked this pull request as ready for review February 20, 2025 15:59
@DnlLrssn
Copy link
Member Author

image

This will fail one documentation.go has not been generated after changes

Copy link
Contributor

@atluq atluq left a comment

Choose a reason for hiding this comment

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

This makes it so much easier to navigate the docs. Great work!

Two general feedback points that can be fixed here or as continuous improvements somewhere else:

  1. It would be more readable and easier to maintain if we just had a good word separated and capitalized page name and not have the top level header repeating the same info or even saying something else. The exception is generated pages where the header have a programmatic meaning.
  2. It would be a bit easier to navigate if link names and page names matched everywhere.

@DnlLrssn DnlLrssn merged commit eeabb81 into master Feb 24, 2025
3 checks passed
@DnlLrssn DnlLrssn deleted the documentation/1584-actions-to-wiki branch February 24, 2025 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants