docs: comprehensive documentation reorganization and enhancement #545
Conversation
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
- Add clear separation: tutorials, how-to, explanation, reference - Create index pages for each documentation section - Move cookiecutter guide from user-guide to how-to section - Add core concepts and JSON-LD basics to explanation section - Create new how-to guides for common tasks - Update navigation structure in mkdocs.yml
- Enhanced validation guide with common errors and solutions - Enhanced visualize guide with demo protocol link and troubleshooting - Added prerequisites, best practices, and advanced options - Improved user experience with practical examples
- Create complete field types reference with all input types - Include examples for text, numeric, selection, media, and special inputs - Add response options properties and validation rules - Update reference index and navigation in mkdocs.yml
- Add comprehensive translation guide for multilingual schemas - Add deployment guide with multiple hosting options - Update how-to index with new content management section - Provide practical examples and troubleshooting tips
- Create complete API documentation with examples - Include validation, conversion, and schema creation APIs - Add error handling and configuration sections - Update reference index and navigation in mkdocs.yml
satra
reviewed
Jul 27, 2025
Comment on lines
+10
to
+12
| Protocol | ||
| └── Activity | ||
| └── Item |
There was a problem hiding this comment.
it allows nested activities.
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.
Summary
Complete restructuring and enhancement of ReproSchema documentation following the Diátaxis framework for improved usability and maintainability.
Major Changes
📚 Documentation Restructure (Diátaxis Framework)
🆕 New Content Added
How-To Guides
Explanation Section
Reference Documentation
🔄 Content Migration
🎯 User Experience Improvements
File Changes
Testing
Benefits
This reorganization makes ReproSchema documentation more accessible to newcomers while remaining comprehensive for advanced users.
🤖 Generated with Claude Code