Documentation Update#28
Merged
Merged
Conversation
**Major**: - `glossary.md`: Add glossary of terms and definitions used across the documentation. - `index.md`: Add appendices index to organize and link supplementary documentation. - `LimitsAndKnownIssues.md`: Add document listing known limitations, caveats, and current issues. - `state_and_data_models.md`: Add appendix describing state and data models used by the project.
**Major**: - Architecture details - Guidelines about how to contribute - Info for newcomers - basics about the testing standards in this repo - implementation guides to reuse main components of this codebase
**Major**: - General presentation about Hatch and where to look for information **Minor**: - fixed wrong indentation for some list points
**Major**: - Greatly reduced the content to rather point at the documentation.
Docs/for v0.4.x
Fix/docs broken links
Member
Author
|
This PR's version number has increased as part of the automated version management, but it does not contain any feature or code update. |
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
2 participants
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 introduces Hatch v0.5.1, focusing on documentation improvements, version updates, and enhanced developer resources.
Documentation improvements:
README.mdto provide a concise project overview, clear navigation to canonical documentation, quick start instructions, and contributor guidance, removing detailed CLI/API usage and internal architecture sectionsdocs/articles/users/with many resources for primary users ofhatchincluding tutorialsdocs/articles/developers/with many resources for aspiring contributors including tutorials architecture overview and project practicesdocs/articles/appendices/LimitsAndKnownIssues.mddocumenting critical, significant, moderate, and minor limitations and known issues in Hatch v0.4.2, including workarounds and future mitigation plans.docs/articles/appendices/glossary.mddefining Hatch ecosystem terms and concepts for easier onboarding and reference.docs/_config.ymlto enable the Minima theme to enable github page deployment