Reorganize and update Getting Started documentation #11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fwkoch
commented
Aug 13, 2025
rowanc1
reviewed
Aug 13, 2025
rowanc1
reviewed
Aug 13, 2025
rowanc1
reviewed
Aug 13, 2025
fwkoch
commented
Aug 13, 2025
fwkoch
commented
Aug 13, 2025
fwkoch
commented
Aug 13, 2025
fwkoch
commented
Aug 13, 2025
getting-started/create-a-site.md
Outdated
Comment on lines
83
to
84
| - Recommended: Set this via the web admin interface | ||
| - CLI support available for some workflows |
There was a problem hiding this comment.
We could go into more detail here - I think the CLI method is just as good as (or maybe better than) the admin interface. Maybe this will link to another page with much more detail, and users can choose which they prefer?
getting-started/create-a-site.md
Outdated
Comment on lines
119
to
122
| You’ll be prompted to: | ||
|
|
||
| - Select an existing site | ||
| - Choose a collection (e.g., "Lab Articles") |
There was a problem hiding this comment.
You must provide the site up front, when you call curvenote submit <site>. From there, you may be prompted to choose collection and/or kind
getting-started/create-a-site.md
Outdated
Comment on lines
126
to
132
| ### 6. Push Changes (Optional: Internal Review) | ||
|
|
||
| ```bash | ||
| curvenote push | ||
| ``` | ||
|
|
||
| This allows collaborators to preview your work, but does not make it publicly visible. |
There was a problem hiding this comment.
This is pushing a work and probably separate from the site submission workflow. It does not allow collaborators to preview the work, they can only see work metadata in the admin interface.
If you want to allow previewing a work, you must submit it to a site as a draft: include the draft flag. e.g. curvenote submit <site> --draft.
Co-authored-by: Franklin Koch <franklin@curvenote.com>
Co-authored-by: Franklin Koch <franklin@curvenote.com>
Co-authored-by: Franklin Koch <franklin@curvenote.com>
Co-authored-by: Franklin Koch <franklin@curvenote.com>
Co-authored-by: Franklin Koch <franklin@curvenote.com>
Co-authored-by: Franklin Koch <franklin@curvenote.com>
Co-authored-by: Franklin Koch <franklin@curvenote.com>
Co-authored-by: Franklin Koch <franklin@curvenote.com>
Co-authored-by: Franklin Koch <franklin@curvenote.com>
…e CLI steps, and clearer project definition
Updated to our new request site form and tweaked language to align with "manage site"
Replaced incorrect command Clarified article change process
- Updated "Writing a Scientific Paper using Jupyter" to "Write a Scientific Paper using Jupyter" with detailed sections on setup, structure, and best practices. - Expanded "Add & Link Notebooks" with clearer instructions for uploading and linking notebooks. - Revised "Citations" to "Add Citations and References" with improved guidance on adding citations from DOIs and BibTeX files. - Updated "Figures & Images" to "Add Figures, Images, and Media" with comprehensive steps for adding and formatting media. - Enhanced "Interactive Outputs" with detailed instructions for importing and referencing Jupyter outputs in articles.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replaces accidentally merged #10 - Description copied from there:
Overview
This PR reorganizes the Getting Started documentation to improve structure and user experience.
Changes Made
start/index.md→start/getting-started/What-is-curvenote.mdstart/organize-content.md→start/getting-started/create-project.mdmyst.ymlfor improved site structuresites/create-a-site.md,start/organize-content.md)Files Changed
Modified
myst.yml- Site configuration updatesstart/getting-started/install-cli.md- Content improvementsstart/getting-started/create-article-cli.md- Enhanced instructionsstart/getting-started/publish-article.md- Updated guidanceRenamed
start/index.md→start/getting-started/What-is-curvenote.mdstart/getting-started/organize-content.md→start/getting-started/create-project.mdDeleted
sites/create-a-site.md- Outdated contentstart/organize-content.md- Moved to new locationImpact