Open
Conversation
Fix typos (nowaday, seemless, Zendoo, spacecrafts, b_mfi_coulds), grammar (it's/its, subject-verb agreement), broken RST syntax (markdown link in RST, plain text refs), and stale references (README.rst, old project name, astroquery issue). Add CDPP 3DView to data providers listing, document config file paths and cache defaults, and clarify dynamic inventory tab-completion usage. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Restructure around a step-by-step tutorial (find directory, write YAML, restart and use), add a field reference table, a URL placeholder table, explain "how it works" at a high level before diving into details, and clearly separate regular vs random split datasets. Keep the custom reader example unchanged. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
jeandet
added
documentation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
jeandet
force-pushed
the
docs/improve-user-documentation
branch
from
a34329c to
89d8664
Compare
|
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
1 participant
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 focuses on improving documentation clarity, accuracy, and consistency across multiple files. The most important changes include rewriting descriptions for better readability, updating terminology to match current standards, and correcting technical details in configuration and usage instructions.
Documentation clarity and readability improvements:
README.mdanddocs/index.rstto clarify the purpose of Speasy and make the text more accessible to newcomers. [1] [2]docs/user/amda/amda.rst,docs/user/cdaweb/cdaweb.rst,docs/user/cdpp3dview/cdpp3dview.rst,docs/user/Uiowa_eph_tool/uiowa_eph_tool.rst) to use consistent terminology and improve explanations of features and configuration options. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]Configuration and installation updates:
docs/user/configuration.rst, including details about the INI file location, cache settings, and disabling providers. [1] [2] [3]docs/installation.rstto refer to Speasy consistently and updated external links.Technical corrections and terminology updates:
README.rsttoREADME.mdin contribution guidelines.These changes collectively enhance the documentation's usability and accuracy for both new and experienced users.