-
Notifications
You must be signed in to change notification settings - Fork 670
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
restructured doc folders #3434
restructured doc folders #3434
Conversation
Codecov Report
@@ Coverage Diff @@
## main #3434 +/- ##
=======================================
Coverage 83.64% 83.64%
=======================================
Files 56 56
Lines 6800 6800
=======================================
Hits 5688 5688
Misses 1112 1112
|
48fbff6
to
214231f
Compare
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
dd89a5e
to
968821a
Compare
When we merge this we will have to add some redirects in RDT so the old URLs still work. |
Which old URL's were you thinking? I changed the old ones so they point to the new URL's |
389ace4
to
a94b6dd
Compare
52b87a6
to
47d6b49
Compare
The motivation behind this PR is to organize the doc files so that they are in line with how they are represented in the Flax RTD documentation pages. For example, Flax Sharp Bits is currently under
docs/notebooks
, but is displayed as under guides in the Flax RTD documentation.This PR restructures doc folders by doing the following:
docs/guides
anddocs/examples
, and moves all doc files into their corresponding subfoldersdocs/notebooks/full_eval
vs.docs/guides/full_eval
docs/notebooks/optax_update_guide
vsdocs/guides/optax_update_guide
docs/notebooks/orbax_upgrade_guide
vsdocs/guides/orbax_upgrade_guide
docs/notebooks/state_params
vsdocs/guides/state_params
docs/getting_started
todocs/quick_start
docs/guides/jax_for_the_impatient
docs/notebooks/linen_intro
docs/mission.md
docs/overview.md
View docs here.