Skip to content

Conversation

jillianlhale
Copy link
Member

Documentation Restructuring and Content Consolidation

Major Changes:

  • Reorganized navigation structure for better UX
  • Created comprehensive GitHub integration guide
  • Added Getting Started section with 3 new guides
  • Moved files to logical locations and updated all references
  • Fixed rendering issues and ensured content accuracy

Ready for @fwkoch review!

Master Tracking Doc for file paths/names and final approval indicators. https://docs.google.com/spreadsheets/d/1TztUR_AtqKlmye3onTsOKGqCGg1WO83mFrGpE3uY6LY/edit?gid=1715492640#gid=1715492640

@fwkoch fwkoch changed the base branch from main to next August 28, 2025 08:12
…g and content consolidation.

- Reorganized myst.yml with intuitive folder structure (Authoring, Publishing, Command Line Tools, Computational, Site Design, Reference, Getting Started)
- Removed 'Quick Start' and 'Curvenote Editor' sections from TOC
- Moved files to logical locations and updated all cross-references

- Created comprehensive integrations/github.md reference guide
- Added Getting Started section with 3 new guides:
  * account-setup.md - Account creation and profile management
  * first-steps-after-installation.md - Post-installation setup
  * basic-content-creation.md - Content creation fundamentals
- Created authoring/myst-markdown.md with MyST syntax guide
- Added authoring/adding-content.md for content management

- Moved GitHub-related files to publishing/ (github-actions.md, deploying-myst-from-github.md, submissions-using-github.md)
- Moved computational files to Computational/ directory
- Moved export files to publishing/ (export-latex.md, export-pdf.md)
- Moved interactive files to Computational/ (interactive-outputs-in-jupyter.md, reproducible-figures.md)
- Renamed authoring/authors.md to authoring/manage-authors.md

- Updated all new files to use consistent 'Overview' section headers
- Made computational guides more cohesive by combining tips and important notes
- Fixed rendering issues in myst-markdown.md and adding-content.md
- Updated all cross-references to point to new file locations
- Ensured content accuracy by removing 'invented' features

- Removed duplicate update-content.md file
- Deleted old quick-start/ directory files
- Consolidated scattered GitHub documentation into unified reference
- Fixed broken links throughout documentation

- Applied consistent structure (Overview, Before You Start, numbered sections, Next Steps)
- Used :::{important} syntax for callouts
- Ensured all content reflects existing Curvenote features only"
@fwkoch fwkoch changed the base branch from next to design-customize-site August 28, 2025 08:24
@fwkoch fwkoch changed the base branch from design-customize-site to next August 28, 2025 08:24
@fwkoch fwkoch changed the base branch from next to design-customize-site August 28, 2025 08:25
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

Successfully merging this pull request may close these issues.

2 participants