Tizen Docs

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.

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

NOTE

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

Please take a look at the following instructions before starting.

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.