Skip to content

Review filename and rst labels for documentation #148

@brendanreardon

Description

@brendanreardon

When reviewing Pull Request 145, I noticed that there are some inconsistencies with what the filenames are versus what the rst label is. For example, the design decisions file is named "design_decisions.rst" while the rst label is ".. _design-decisions:". This seems to cause some slip ups when referencing other files within the readthedocs. It looks like VRS uses camelcase for basically every rst filename and label, so that may be a convention that we want to adopt.

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or requeststaleIssues or Pull Requests that have been automatically marked as stale by the Stale bot

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions