Skip to content

README.md

Latest commit

 

History

History
120 lines (90 loc) · 7.05 KB

README.md

File metadata and controls

120 lines (90 loc) · 7.05 KB
Raw

Tizen Docs

License License Build Status Build Status Repository Size

This repo contains Tizen documents for platform and application developers.

All files under ./docs/ are hosted on the Tizen Docs site.

Only add information that is suitable for public release. Do not include credentials, private contact information, unreleased product details, or other non-public material.

Repository structure

tizen-docs/
├── docs/                       # Published site source (samsungtizenos.com/docs)
│   ├── application/            # App developer guides — native, web, dotnet, flutter
│   │   └── */api/               # Generated API reference (HTML). Do not hand-edit.
│   ├── sdk-tools/              # SDK and IDE tooling docs — baseline-sdk, vscode-ext,
│   │                            #   vstools, plus the sdktool-index
│   ├── platform/                # Platform/OS docs — HAL, compliance, porting,
│   │                            #   developing, reference, release-notes, what-is-tizen
│   ├── extensions/tizenx/       # TizenX extension SDK guides + generated API reference
│   └── trademarks.md            # Third-party trademark attribution page
├── styleguide/                  # Writing style and naming-rule references
├── reviewguide/                 # PR reviewer walkthroughs (per content type, stg build)
├── tools/                       # Documentation validator, run before every PR
├── .github/                     # CODEOWNERS, pull request template
└── .claude/skills/tizen-docs/   # Claude Code skill for authoring and review

docs/ mixes hand-written Markdown with generated, versioned API-reference dumps (HTML/JS/CSS under */api/**). Of the roughly 80,000 tracked files under docs/, only about 1,900 are hand-authored .md pages; the rest is generated API reference that must be fixed upstream, never edited by hand — see AGENTS.md for the full rule.

For a directory-by-directory breakdown with file counts, see the skill's directory map.

Working with an AI coding agent

Repository-specific instructions for AI coding agents are in AGENTS.md and .claude/skills/tizen-docs/SKILL.md. They explain the public-content boundary, where documents belong, how to update the published navigation, and which generated areas must be fixed upstream.

Validate changed documentation before opening a pull request:

python3 tools/check_docs.py --changed-only --base origin/master
git diff --check

ERROR findings block the pull request. WARN findings do not block, but each one must be fixed or explained before approval. A successful run always prints a summary line such as check_docs: 0 ERROR, 0 WARN (12 files); if nothing is printed at all the validator did not run, so check the --base revision.

If the change deletes, renames or moves a document, the same command also reports what that breaks elsewhere in the repository. See .claude/skills/tizen-docs/SKILL.md for the full workflow, and python3 tools/check_docs.py --help for the other options.

NOTE

To contribute, see the Contributing Guide and the issues list.

Please take a look at the following instructions before starting.

Write issues and pull requests in English.

Workflow

We are going to review Review/Requested PRs.

  1. Contributors have to attach Review/Requested, as soon as creating a PR.
  2. Reviewers have to change the label to Review/Reviewing when they starts to review a PR.
  3. When one of reviewers approve a PR, he/she has to update the label to Review/Scheduled.
  4. Although the state is Review/Scheduled others can change it to Review/Reviewing when more improvements are needed.

Naming rules

Naming Rules for Tizen Terms was added.

Headings style

Please see the Headings style.

...

Use sentence-style capitalization. Always capitalize:

  • The first word of a heading.
  • The word following a colon in a title or heading (for example, "How to: Sort an array").
    Headings should be done using atx-style, that is, use 1-6 hash characters (#) at the start of the line to indicate a heading, corresponding to HTML headings levels H1 through H6. Examples of first- and second-level headers are used above.

...

License

The Tizen documents in this project are licensed under the Creative Commons Attribution 3.0 License and the Code Examples are under the BSD-3-Clause License. See Content License for more details.