Skip to content

Refactor Schema and Schema Data Related Documentation #418

@bflad

Description

@bflad

Module version

v0.10.0

Use-cases

The website documentation is less than ideal as it has quite a few schema-related pages as top-level in the lengthy side navigation. In particular:

It would be clearer if these were bundled together as they are conceptually related.

Proposal

Create a new top-level section named "Schemas and Schema Data" or "Schemas and Config/Plan/State" with the following:

  • Overview page, brief introduction to the concepts and linking to others
  • Redirected accessing values page
  • Redirected paths page
  • Redirected path expressions page
  • Redirected schemas page (maybe "Schema Definitions"?)
  • Redirected writing state page (probably should not say state as it also related to setting the plan in plan modifiers)

Doing this will likely warrant fixing wording/flow for all the concepts/pages to ensure they seem cohesive together.

References

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions