Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small doc-related updates #367

Open
6 tasks
anngvu opened this issue Nov 1, 2023 · 0 comments
Open
6 tasks

Small doc-related updates #367

anngvu opened this issue Nov 1, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation priority: low

Comments

@anngvu
Copy link
Collaborator

anngvu commented Nov 1, 2023

Cluster of minor doc-related suggested updates for this repo from internal review/strategy meeting.

  • Rationale section for how requirements are considered
  • What validation/revalidation means in terms of these requirements
  • Key for background highlighting of (required) elements
  • Further structure templates to split up raw vs processed
  • Add notations/mappings to Level 1/2/3/4, etc. where possible
  • (Maybe) Example for filled-out templates
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority: low
Projects
None yet
Development

No branches or pull requests

1 participant