[doc] Update documentation links and improve content in notebooks#14
Merged
chaoming0625 merged 3 commits intomainfrom Apr 19, 2025
Merged
[doc] Update documentation links and improve content in notebooks#14chaoming0625 merged 3 commits intomainfrom
chaoming0625 merged 3 commits intomainfrom
Conversation
Contributor
Reviewer's Guide by SourceryThis pull request updates a broken link in the FAQ documentation. The old link pointed to a No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey @Routhleck - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
chaoming0625
approved these changes
Apr 19, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates various documentation files to fix outdated or incorrect URLs, ensuring they point to the correct locations in the
saiunitdocumentation. The changes primarily involve removing/en/latestfrom the URLs and updating paths to match the current structure of the documentation.Updates to Documentation URLs:
General Documentation Links:
saiunitandbrainunitREADME files to remove/en/latestfrom the ReadTheDocs links for documentation badges. (README.md: [1]brainunit/README.md: [2]Physical Units Documentation:
docs/FAQs.md: docs/FAQs.mdL95-R95)math_operations_with_quantityandquantitynotebooks to remove/en/latestand reflect the updated documentation structure. (docs/physical_units/math_operations_with_quantity.ipynb: [1]docs/physical_units/quantity.ipynb: [2] [3]Mathematical Functions Documentation:
fft_functions,lax_functions,linalg_functions, andnumpy_functionsnotebooks to remove/en/latestand ensure paths align with the updated documentation structure. (docs/mathematical_functions/fft_functions.ipynb: [1]docs/mathematical_functions/lax_functions.ipynb: [2]docs/mathematical_functions/linalg_functions.ipynb: [3]docs/mathematical_functions/numpy_functions.ipynb: [4] [5] [6] [7] [8] [9] [10] [11]Advanced Tutorials:
docs/advanced_tutorials/mechanism.ipynb: docs/advanced_tutorials/mechanism.ipynbL66-R66)These changes improve the accuracy and usability of the documentation by ensuring all links are functional and up-to-date.