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

Docs cleanup #1197

Open
7 tasks
dbirman opened this issue Dec 13, 2024 · 0 comments
Open
7 tasks

Docs cleanup #1197

dbirman opened this issue Dec 13, 2024 · 0 comments
Assignees

Comments

@dbirman
Copy link
Member

dbirman commented Dec 13, 2024

User story

As a user I want to get only data-schema specific information from the aind-data-schema documentation. Not AIND-specific information. Once the new https://scicomp-docs.readthedocs.io/en/latest/index.html page is filled out we can start removing content from here and simplifying.

Acceptance criteria

  • All AIND-specific FAQs moved to scicomp-docs
  • All core schemas have an example with details about fields users often find confusing
  • Data organization replaced with "Naming conventions", philosophy section moved to scicomp-docs
  • Diagrams removed
  • Front page examples moved into relevant files
  • Hide TOC section indices/tables on front page
  • Reduce use of Q&A style in "metadata in general" page

Notes

Blocked by: https://github.com/AllenNeuralDynamics/aind_data_outreach/issues/49

@dbirman dbirman self-assigned this Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant