Skip to content

docs: Enhance documentation with detailed examples and troubleshooting tips for OSL JSON format#23

Merged
SilvioGiancola merged 1 commit into
mainfrom
dev-silvio
May 19, 2026
Merged

docs: Enhance documentation with detailed examples and troubleshooting tips for OSL JSON format#23
SilvioGiancola merged 1 commit into
mainfrom
dev-silvio

Conversation

@SilvioGiancola
Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings May 19, 2026 15:33
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md and assets/README.md from 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.

@SilvioGiancola SilvioGiancola merged commit 6832c90 into main May 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants