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

docs updates #170

Merged
merged 23 commits into from
Sep 28, 2023
Merged

docs updates #170

merged 23 commits into from
Sep 28, 2023

Conversation

shouples
Copy link
Contributor

@shouples shouples commented Sep 27, 2023

Easier to compare old vs new instead of looking at the files changed tab.

Details:

  • updated content/wording to mainly move all of the Usage examples of the README into the docs Quick Start section since it was previously missing from the docs altogether
  • breaks up the quickstart usage snippets for easier handling and formatting
  • separates admonitions between GH flavored markdown format in README and the mkdocs formats in the docs/ pages
  • adds screenshots for setting up the API tokens
  • updates mkdocs configs for syntax highlighting, code copying, admonitions support
  • adds dark papersnake logo and updates colors to fit closer to Noteable brand theme
  • removed references to the "1.0 alpha" period
  • adds github pages deployment

before/after
image

@shouples shouples self-assigned this Sep 27, 2023
@shouples shouples added the documentation Improvements or additions to documentation label Sep 27, 2023
@shouples shouples marked this pull request as ready for review September 28, 2023 00:24
@shouples shouples merged commit 2f58315 into main Sep 28, 2023
@shouples shouples deleted the djs/docs-updates branch September 28, 2023 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants