Skip to content

Inconsistent docs introductions #1609

Closed
@sjberman

Description

@sjberman

Throughout our docs, we have some inconsistencies in how the docs are introduced. Some docs have descriptions in the doc metadata while others don't. Some docs start with an Overview header, while others don't.

We should ensure all of our docs are consistent in how they are introduced. If we feel that the metadata description is redundant in favor of an Overview section, then we should remove it.

Acceptance:

  • determine and implement a consistent way to introduce each document

Metadata

Metadata

Assignees

Labels

backlogCurrently unprioritized work. May change with user feedback or as the product progresses.documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions