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

restructured doc folders #3434

Merged
merged 1 commit into from
Nov 2, 2023
Merged

restructured doc folders #3434

merged 1 commit into from
Nov 2, 2023

Conversation

chiamp
Copy link
Collaborator

@chiamp chiamp commented Oct 24, 2023

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:

View docs here.

@chiamp chiamp marked this pull request as draft October 24, 2023 17:29
@codecov-commenter
Copy link

codecov-commenter commented Oct 24, 2023

Codecov Report

Merging #3434 (a94b6dd) into main (8d09772) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #3434   +/-   ##
=======================================
  Coverage   83.64%   83.64%           
=======================================
  Files          56       56           
  Lines        6800     6800           
=======================================
  Hits         5688     5688           
  Misses       1112     1112           
Files Coverage Δ
flax/jax_utils.py 44.06% <ø> (ø)
flax/training/checkpoints.py 68.69% <ø> (ø)
flax/traverse_util.py 99.01% <ø> (ø)

@chiamp chiamp force-pushed the docs branch 4 times, most recently from 48fbff6 to 214231f Compare October 24, 2023 19:01
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@chiamp chiamp mentioned this pull request Oct 24, 2023
4 tasks
@chiamp chiamp force-pushed the docs branch 6 times, most recently from dd89a5e to 968821a Compare October 24, 2023 23:39
@chiamp chiamp self-assigned this Oct 24, 2023
@chiamp chiamp marked this pull request as ready for review October 24, 2023 23:50
@chiamp chiamp requested a review from cgarciae October 24, 2023 23:50
@cgarciae
Copy link
Collaborator

When we merge this we will have to add some redirects in RDT so the old URLs still work.

@chiamp
Copy link
Collaborator Author

chiamp commented Oct 25, 2023

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

@chiamp chiamp requested a review from andsteing October 25, 2023 16:22
@chiamp chiamp force-pushed the docs branch 3 times, most recently from 389ace4 to a94b6dd Compare October 31, 2023 18:16
@chiamp chiamp force-pushed the docs branch 4 times, most recently from 52b87a6 to 47d6b49 Compare November 2, 2023 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants