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

Knowledge base home page #38

Merged
merged 6 commits into from Mar 7, 2022
Merged

Knowledge base home page #38

merged 6 commits into from Mar 7, 2022

Conversation

phitoduck
Copy link
Collaborator

@phitoduck phitoduck commented Mar 7, 2022

This is the beginning of a version-controlled rewrite using sphinx of the original knowledge base site on notion: https://quickest-trail-808.notion.site/Rootski-Knowledge-Base-49bb8843b6424ada9f49c22151014cfc

I wrote a home page for docs.rootski.io and made several small improvements. You can visit the version of the docs built by this PR using the link further down in this PR conversation :D

  1. the browser tab
    • added 📚 favicon
    • set title to "Knowledge Base"
  2. added a small "pencil" icon to each page that lets you edit each docs page on GitHub; unfortunately, you have to enable "ReadTheDocs" mode for the pencil to appear, so I added a JS file that deletes a RTD menu that pops up when you open the site.
  3. added a CSS file that adds a ↩️ icon to every "external" link so that users know which links take them off of the docs site (thank you FastAPI docs for the inspiration for this!)
  4. created an rst/ folder where we will place all of our articles and other site content
  5. added font-awesome CSS files to render
    • the LinkedIn, github, YouTube, and slack icons in the site footer
    • the "Helpful Links" section in the docs.rootski.io homepage
  6. Added profile pictures of contributors to the docs.rootski.io homepage by creating a new CONTRIBUTORS.md file and registered it with the all-contributors CLI.
  7. Achieved (6) and made it easier to credit future contributors by adding makefile targets to work with the all-contributors CLI.

image

@github-actions
Copy link

github-actions bot commented Mar 7, 2022

The docs for the most recent build have been published here: https://docs.rootski.io/review/knowledge-base-home-page. Please verify that they render correctly.

@github-actions
Copy link

github-actions bot commented Mar 7, 2022

The docs for the most recent build have been published here: https://docs.rootski.io/review/knowledge-base-home-page. Please verify that they render correctly.

@codecov-commenter
Copy link

Codecov Report

Merging #38 (9e65e81) into trunk (5ea6e88) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##            trunk      #38   +/-   ##
=======================================
  Coverage   73.70%   73.70%           
=======================================
  Files          42       42           
  Lines        1289     1289           
  Branches      181      181           
=======================================
  Hits          950      950           
  Misses        317      317           
  Partials       22       22           
Impacted Files Coverage Δ
...otski_api/src/rootski/gql/language/word/loaders.py 42.85% <ø> (ø)
...api/src/rootski/main/endpoints/breakdown/routes.py 80.76% <ø> (ø)
...api/src/rootski/services/database/models/models.py 99.38% <ø> (ø)
...rc/rootski/services/database/non_orm/db_service.py 21.18% <ø> (ø)
...rc/rootski/services/database/non_orm/sql_client.py 0.00% <ø> (ø)
rootski_api/src/rootski/config/config.py 90.38% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 03bc0da...9e65e81. Read the comment docs.

@phitoduck phitoduck merged commit a60579f into trunk Mar 7, 2022
@phitoduck phitoduck deleted the knowledge-base-home-page branch March 7, 2022 20:59
@dleybz
Copy link

dleybz commented Mar 7, 2022

Never forget the importance of docs in turning minimum viable products into minimum lovable products! Docs are essential for usability

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants