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

feat: add 'all' option to add all the documentation to the readme in one go #537

Merged
merged 37 commits into from
Mar 9, 2024

Conversation

larmitage-bjss
Copy link
Contributor

To merge after #523

I think this functionality is especially useful with the new ability to document workflows as you may (like me) have a readme in your .github/workflows directory where you want to document a number of workflows, and this makes it easier having one comment per workflow to insert all the docs at once

larmitage-bjss and others added 30 commits February 13, 2024 15:27
npalmGH-240 update CONTRIBUTING where command does not work and add additi…
npalmGH-240 add option to have a top level header containing the name
@npalm
Copy link
Owner

npalm commented Feb 16, 2024

This PR seems on top of another or not? TIle mention only docs are changed.

@larmitage-bjss
Copy link
Contributor Author

@npalm yes, it depends on #523 being merged first

@npalm
Copy link
Owner

npalm commented Mar 6, 2024

@larmitage-bjss this PR requires after mering the workflow one a rebase.

@larmitage-bjss
Copy link
Contributor Author

@npalm this is ready for review please

Copy link
Owner

@npalm npalm left a comment

Choose a reason for hiding this comment

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

@larmitage-bjss thx looks all good. Great contribution again 🚀

@npalm npalm changed the title Add 'all' option to add all the documentation to the readme in one go feat: add 'all' option to add all the documentation to the readme in one go Mar 9, 2024
@npalm npalm merged commit dc70838 into npalm:main Mar 9, 2024
5 checks passed
@larmitage-bjss larmitage-bjss deleted the all-in-readme branch March 11, 2024 09:17
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.

2 participants