Closed Archmonger closed 1 year ago
@rmorshea Can you pull down this branch and check out the new docs styling with mkdocs serve
?
I went pretty deep into making it feel React-like.
requirements.txt
is a little out of date with the current requirements/*.txt
files. Can you update it to:
-r requirements/build-docs.txt
-r requirements/build-pkg.txt
-r requirements/check-style.txt
-r requirements/check-types.txt
-r requirements/dev-env.txt
-r requirements/pkg-deps.txt
-r requirements/test-env.txt
-r requirements/test-run.txt
Overall, I think the docs look great. I'm excited to have the core docs done in this style. The only criticism I have at the moment is that there may be some over reliance on admonitions. I don't have any alternate suggestions at the moment, but this is a thought I had when looking at this particular case:
I'm realizing I completely forgot to checkout this branch when I checked out the docs. The similarity to React's docs is uncanny! In some ways I prefer the mkdocs styling. I always found this part of the sidebar in the beta docs to be busy and distracting for some reason:
and since mkdocs doesn't have that the left sidebar is much more readable.
I considered replicating the react docs sidebar while doing this styling. But ultimately agreed with you that I think mkdocs layout is better.
Additionally if we did that, we'd be changing the mkdocs jinja templates, which is more prone to catastrophically breaking under future updates of mkdocs.
requirements.txt is a little out of date with the current requirements/*.txt files. Can you update it to:
I left test-run.txt
out since it seems like you're already installing it within dev-env.txt
. I will re-add it for completeness.
Description
idom.html
APIidom>=1.0.0
requirements.txt
be fully inclusive of all dev/user/docs dependencies to simplify development workflowsetup.py
to automatically install the latest NPM, and be easier to debug when things failChecklist:
Please update this checklist as you complete each item: