Documentation: Restructure documentation based on Diátaxis framework

[ehennestad]

Motivation

Restructure documentation inspired by Diátaxis framework

Docs Preview

Todo

• DataPipe currently does not support editing data in place. This needs to be clear in the section on editing NWB files.
• Add todos in following issues to update documentation when issues are resolved:
  • [Feature]: Support export of a bound DataPipe to a new file. #751 and
  • [Feature]: Support editing data "in place" for datasets that have been exported to file. #760

Points for improvements:

• DataPipe currently does not have its own reference page. Will be added in a future PR
• DataStub currently does not have its own reference page. Will be added in a future PR

Copilot summary

This pull request restructures the MatNWB documentation by adopting the Diátaxis framework, which organizes documentation into four types: tutorials (learning-oriented), how-to guides (problem-oriented), explanations/concepts (understanding-oriented), and reference (information-oriented).

• Adds reference anchors to all tutorial files for cross-referencing
• Reorganizes documentation structure with new sections for "Get Started," "How-tos," and "Concepts"
• Creates new content including quickstart guide, overview, installation guide, and concept explanations
• Added Create NWB File concept page with subpages.

Reviewed Changes

Copilot reviewed 42 out of 47 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
Tutorial files (.rst)	Add reference anchors for cross-referencing
docs/source/index.rst	Complete restructure to follow Diátaxis framework with new sections
New getting_started files	Add quickstart, overview, and installation guides
New concepts files	Add explanations for file reading, creation, and NWB concepts
Configuration files	Update Sphinx configuration and add documentation README

Checklist

• Have you ensured the PR description clearly describes the problem and solutions?
• Have you checked to ensure that there aren't other open or previously closed Pull Requests for the same change?
• If this PR fixes an issue, is the first line of the PR description fix #XX where XX is the issue number?

[codecov]

Codecov Report

❌ Patch coverage is 95.16129% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.59%. Comparing base (8d5173c) to head (33881e6).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
NwbFile.m	83.33%	2 Missing ⚠️
nwbExport.m	91.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #729      +/-   ##
==========================================
- Coverage   95.60%   95.59%   -0.01%     
==========================================
  Files         183      184       +1     
  Lines        6388     6443      +55     
==========================================
+ Hits         6107     6159      +52     
- Misses        281      284       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull Request Overview

This pull request restructures the MatNWB documentation by adopting the Diátaxis framework, which organizes documentation into four types: tutorials (learning-oriented), how-to guides (problem-oriented), explanations/concepts (understanding-oriented), and reference (information-oriented).

• Adds reference anchors to all tutorial files for cross-referencing
• Reorganizes documentation structure with new sections for "Get Started," "How-tos," and "Concepts"
• Creates comprehensive new content including quickstart guide, overview, installation guide, and concept explanations

Reviewed Changes

Copilot reviewed 42 out of 47 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
Tutorial files (.rst)	Add reference anchors for cross-referencing
docs/source/index.rst	Complete restructure to follow Diátaxis framework with new sections
New getting_started files	Add quickstart, overview, and installation guides
New concepts files	Add explanations for file reading, creation, and NWB concepts
Configuration files	Update Sphinx configuration and add documentation README

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[bendichter]

It seems odd to start a tutorial with what cannot be done

[bendichter]

I think we need a How-to for this really more than a concept guide

[ehennestad]

It seems odd to start a tutorial with what cannot be done

I think it's important to be upfront about it though. Also opened issues for following up and potentially fix these limitations

I think we need a How-to for this really more than a concept guide

Agree. This PR is already huge so I would prefer to do that as a separate task