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

reorganize docs into folders, fix links #919

Closed
wants to merge 1 commit into from

Conversation

patricksurry
Copy link
Contributor

Reorganizes docs into folders following the getting started guide, fixing various broken links.

I also included an environment.yml and mkdocs.yml for local testing and link checking via mkdocs + mkdocs-material:

micromamba create -f environment.yml
mkdocs serve

then browse at http://127.0.0.1:8000/en/

It looks pretty good with almost no config and has language selector plus search for free 🔥 But these changes should also be fine with the existing website.

image

@claycooper
Copy link
Member

Thanks for your work here. I'm going through what publishing the pages might look like and have started a conversation with the other reviewers about the direction for documentation.

@patricksurry
Copy link
Contributor Author

i'm far from an expert, but github pages might even be viable for the docs pages themselves, and just link from the website? i've used that with mkdocs before.

@claycooper
Copy link
Member

I tried running the commands provided without success. I'm not familiar with micromamba and Google is not being a friend with that error.

warning  libmamba No 'channels' specified
error    libmamba Could not solve for environment specs
    The following packages are incompatible
    ├─ pip does not exist (perhaps a typo or a missing channel);
    └─ python does not exist (perhaps a typo or a missing channel).
critical libmamba Could not solve for environment specs

@patricksurry
Copy link
Contributor Author

I think it's this issue. Try micromamba config --add channels conda-forge

@claycooper
Copy link
Member

We've removed the non-English versions of the docs in #933 . Can you re-base to include those changes and other updates to docs that have happened over time? I'm also working on getting a theme closer to the current site's main color and adding a favicon and can push those to this PR. If you want to attempt that before I get to it, then go ahead.

@claycooper claycooper self-assigned this Jan 24, 2024
@claycooper
Copy link
Member

Because of access issues and wanting to preserve existing document pathing I've taken your work over to the kmk_website repository and pushed an initial version to the website. Thank you for getting this work started.

@claycooper claycooper closed this Apr 3, 2024
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.

2 participants