Document repository structure and link reviewguide/ from the skill - #2363
Merged
Conversation
Add a Repository structure overview to README.md and a detailed directory-map reference to the tizen-docs Claude Code skill, covering docs/application, platform, extensions/tizenx, iot, and partners, and flagging which subtrees (*/api/**) are generated content that must not be hand-edited. Also link the five reviewguide/ documents from SKILL.md's Review workflow section — they existed but were not referenced by the skill, so review guidance for web API HTML, release notes, and the stg/live publish flow was easy to miss.
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.
Change Description
docs/, and a note that most of the ~80k files tracked under docs/ are generated,
versioned API reference (under */api/**) rather than hand-authored Markdown.
breakdown (application/{native,web,dotnet,flutter,tizen-studio,vscode-ext,vstools,...},
platform/, extensions/tizenx/, iot/, partners/, blog/*) with file counts and notes
on which subtrees are generated content, for use when choosing where a new document
belongs or reviewing a PR's placement.
destination" steps.
section. They were not referenced by the skill before this change, so guidance such as
"application/web/api files must use HTML markup, not Markdown" (review_points_web_api.md)
or how to use the stg preview build (stg_build.md) was easy for a reviewer to miss.
No content under docs/ changes;
tools/check_docs.py --changed-only --base masterandgit diff --checkboth pass clean.Bugs Fixed
API Changes