Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

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

Copy link
Copy link
Open
@story645

Description

@story645
Issue body actions

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.