Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Doc]: Sort out doc mechanics/formatting/content guides #26392

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

Open
Tracked by #26196
story645 opened this issue Jul 26, 2023 · 0 comments · May be fixed by #28578
Open
Tracked by #26196

[Doc]: Sort out doc mechanics/formatting/content guides #26392

story645 opened this issue Jul 26, 2023 · 0 comments · May be fixed by #28578

Comments

@story645
Copy link
Member

Documentation Link

No response

Problem

We have these two documentation guides where the write docs page is a mix of "how to build", and formatting and content guidelines and the "style guide" mixes formatting and content:

Suggested improvement

Build related docs should go on a different page from formatting and content related guides. The content is of a different type and scope and separating it out will down the line help us surface it more cleanly in TOCs, sidebars, and the like and give us more flex if we decide it belongs in workflow rather than guidelines.

I also think we should separate out formatting from content guidelines. The major reason is that the general formatting guidelines apply to all the docs regardless of what type, while content specific guides are specific to docstrings/examples/tutorials/user guide and seperating this out may make it easier to communicate that. It will also allow us to reduce some of the replication we're currently seeing across the style and writing guides. My bias is to put each set of content guidelines on its own page (so like "docstring content guidelines") in a docsdoc/content folder but that's mostly b/c of my preference for small scoped docs pages.

Somewhat inspired by @esibinga's GSOD work and trying to figure out where to put it.

@story645 story645 changed the title [Doc]: Sort out doc mechanics/formatting/concept guides [Doc]: Sort out doc mechanics/formatting/style guides Aug 1, 2023
@story645 story645 changed the title [Doc]: Sort out doc mechanics/formatting/style guides [Doc]: Sort out doc mechanics/formatting/content guides Aug 1, 2023
@story645 story645 linked a pull request Feb 12, 2025 that will close this issue
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant