Skip to content

Conversation

@jillianlhale
Copy link
Member

PR Summary: Restructured Getting Started Documentation

Overview

Completely restructured the getting-started workflow to provide a clearer, more logical onboarding experience for new Curvenote users. The new structure follows a step-by-step progression from installation through first publication.

Key Changes

📝 Content Structure & Flow

  • Reorganized workflow sequence: Install → Create Project → Write Article → Create Site → Publish
  • Improved goal-oriented approach: Each guide now starts with a clear "Goal" statement
  • Added consistent "Next Steps" navigation between guides

🔧 Technical Improvements

install-cli.md

  • Added clear prerequisites (Node.js v18+)
  • Improved installation verification steps
  • Enhanced authentication workflow with token management
  • Fixed reference links and added CLI GitHub link

create-project.md

  • Completely rewrote project creation workflow
  • Added detailed explanation of what a Curvenote project contains
  • Improved file organization best practices
  • Added example folder structures
  • Clarified the curvenote init options and workflow

create-article-cli.md

  • Streamlined article creation process
  • Added practical examples with frontmatter
  • Improved local preview instructions
  • Enhanced organization tips for multi-article projects

create-a-site.md

  • Added comprehensive site creation workflow with visual flowchart
  • Included detailed checklist for site setup
  • Improved metadata requirements explanation
  • Enhanced submission and publishing process clarity

publish-article.md

  • Simplified publishing workflow
  • Added content readiness checklist
  • Improved update/republishing instructions
  • Enhanced troubleshooting guidance

what-is-curvenote.md

  • Rewrote core value proposition focusing on "living research outputs"
  • Improved feature explanations (modular, versioned, web-first)
  • Added clearer platform component descriptions
  • Enhanced "why it matters" messaging

🎯 User Experience Improvements

  • Consistent formatting: Standardized headings, code blocks, and navigation
  • Better cross-references: Fixed and improved links between guides
  • Clearer language: Removed jargon, added practical examples
  • Goal-oriented structure: Each guide focuses on achieving specific outcomes

Impact

These changes create a much smoother onboarding experience for new users, reducing confusion and providing clear pathways from installation to first publication.

@jillianlhale jillianlhale requested a review from fwkoch August 15, 2025 18:19
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.

4 participants