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.

Sign up for GitHub

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

Jump to bottom

spike: find a workaround for docs README generation #507

Open
dbkegley opened this issue May 16, 2024 · 1 comment
Open

spike: find a workaround for docs README generation #507

dbkegley opened this issue May 16, 2024 · 1 comment
Assignees
@dbkegley

Comments

@dbkegley
Copy link
Collaborator

related: #485 (comment)
related: #505

The README templating that we do in CI has caused some docs updates to be lost because it's not obvious to contributors that the README is auto-generated from the templates. Better "how to contribute" documentation may be a short term option to help with this, but longer term we should find a workaround that doesn't require a github action that makes a new commit to the repo.

Having to push/pull constantly while iterating on a PR is also a bit tedious.
@dbkegley dbkegley self-assigned this May 16, 2024
@dbkegley
Copy link
Collaborator Author

cc @colearendt do you have thoughts on this? I'd personally like to see the README generation in CI stop entirely and have the readme be generated as part of a local just docs action or something similar. It should be up to the PR author to update the README to make it easier for reviewers to see what's changing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dbkegley dbkegley

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dbkegley