Skip to content

Revise top-level documentation structure #121

@infotexture

Description

@infotexture

As discussed in March and June docs calls, the artificial book-based distinction between User Guide & Developer Reference in the documentation should be replaced with more task-oriented groupings.

These changes are intended to improve the navigational structure and make frequently accessed topics more discoverable, rather than hiding them under the current “book” titles.

Initial brainstorming suggests top-level items such as:

  • Installing
  • Building/Publishing
  • Customizing/Extending/Plugins
  • Troubleshooting

(Since this change would affect the URL structure of the online docs, it would need to coincide with a major release, since the URLs of topics in released documentation should not be changed.)

The process will begin with a content audit, in which the docs team reviews the current topic structure and proposes new locations in the hierarchy for each topic and suggests index terms for #53.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementChanges to an existing topic or featurerefactoringChanges to organization of docs source

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions