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: add new docs structure #816

Merged
merged 57 commits into from
Jan 7, 2025
Merged

docs: add new docs structure #816

merged 57 commits into from
Jan 7, 2025

Conversation

marikaris
Copy link
Collaborator

@marikaris marikaris commented Nov 14, 2024

What have I done?

  • Removed the old docs folder. We need to look at our old docs on the master and see what we can copy paste in this new structure from there.
  • Initialised mkdocs
  • Added in agreed upon structure. Each file in the menu has the key words that should be in the article in them.
  • Added css that somewhat matches molgenis theme

Test running docs

Mkdocs allows for seeing what the docs will look like locally, if you prefer to do so. You do need to have python and pip installed, as well as mkdocs:

pip install mkdocs
pip install mkdocs-material
pip install pymdown-extensions

After that, simply run this in the armadillo repository:

mkdocs serve

The docs will then run on:
http://localhost:8000/

MkDocs Material Theme

See getting started and reference formatting options for the material theme for MKDocs

To do

(please put your initials to the point if you're working on it)

  • Index (MkS)
  • Quick start (MkS)
  • About us (There's something there, but it needs more)
  • Basic concepts (MkS)
  • Basic usage (ez)
  • Example of usage (We could skip this for now?)
  • Advanced usage (We could skip this for now?)
  • Installation, setup and managment (ez)
  • Developer guides (MkS)
  • License (ez)
  • FAQ (ez)
  • Troubleshooting
  • Contact (ez)
  • Go through old md files scattered throughout repo and move things into docs + link to docs
  • Build docs automatically
  • Link to built docs in UI
  • Add cite us message to readme + docs
  • Rewrite readme to include very quick start

Copy link

sonarqubecloud bot commented Dec 4, 2024

@marikaris marikaris marked this pull request as ready for review January 6, 2025 10:18
@marikaris marikaris requested a review from mswertz January 6, 2025 10:26
@marikaris marikaris merged commit a86ab9f into master Jan 7, 2025
3 of 4 checks passed
@marikaris marikaris deleted the docs/restructure branch January 7, 2025 07:26
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