docs: Enhance documentation with detailed examples and troubleshooting tips for OSL JSON format#23
Merged
Merged
Conversation
…g tips for OSL JSON format
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation refresh: expands the OSL JSON format guidance, getting-started walkthrough, save/load behavior, batch tools, and troubleshooting; excludes repo README files from the published site; adds changelog notes.
Changes:
- Adds examples, common-mistake tables, and notes about relative paths and grouped Q/A across multiple doc pages.
- Updates CLI script paths to
tools/...and adds new converter command sections. - Excludes top-level
README.mdandassets/README.mdfrom the mkdocs build.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Excludes repository README files from the docs site build. |
| docs/OSL.md | Adds a minimal valid example and a common-mistakes table. |
| docs/getting_started.md | Restructures the walkthrough with tabs table and save behavior summary. |
| docs/saving_loading.md | Expands load/save behavior, normalization details, and persisted-fields lists. |
| docs/annotating.md | Clarifies per-tab workflows and the JSON fields each writes. |
| docs/batch_tools.md | Updates CLI script paths and adds converter command examples. |
| docs/troubleshooting.md | Adds JSON load, missing media, and clarified HF/video sections. |
| docs/changelog.md | Adds documentation notes and a release-notes link. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.