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

Do we really need both the _docs-sources and docs folders? #1787

Open
josh-padnick opened this issue Jun 19, 2024 · 1 comment
Open

Do we really need both the _docs-sources and docs folders? #1787

josh-padnick opened this issue Jun 19, 2024 · 1 comment

Comments

@josh-padnick
Copy link
Contributor

I find it super confusing to have to edit code in one of the /_docs-sources or /docs folders, wait for the code to be generated locally, and then commit both. A more natural workflow would be we edit one of those folders, and do the git commit. Then when the docs site update is published, it generates the right code.

If we want to validate that it does in fact build correctly before we commit the release, then we should probably bake that in as an automated test to validate the build rather than a user workflow.

Plus, consider if users want to contribute to docs. Having to ramp up on two different folders will be all the more confusing.

@josh-padnick
Copy link
Contributor Author

@ZachGoldberg Would be grateful if you could fix this one, too!

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