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

Add user documentation #47

Merged
merged 13 commits into from
Sep 30, 2024
Merged

Add user documentation #47

merged 13 commits into from
Sep 30, 2024

Conversation

krassowski
Copy link
Member

Reference Issues or PRs

Closes #23

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

Copy link

Binder 👈 Launch a Binder on branch nebari-dev/jupyterlab-gallery/add-user-documentation

@krassowski
Copy link
Member Author

bot please update snapshots

Copy link
Member Author

@krassowski krassowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar self-review

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@krassowski
Copy link
Member Author

Note: the failure of "Check links" CI job is expected and will go away once this PR gets merged (because we are using absolute URLs for the snapshots which are being added in this PR).

@krassowski krassowski merged commit b2cad9c into main Sep 30, 2024
5 of 6 checks passed
@krassowski krassowski deleted the add-user-documentation branch September 30, 2024 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to update repository (pull new changes)
1 participant