How to contribute

The base is a GitHub repo. Every time someone saves, the site rebuilds in about 1–2 minutes.

You need: a GitHub account invited to the Fine-chemical-All-in-one-Data repo with Write access. Ask the BA to invite you.

Option 1 — Edit one page in the browser (recommended)

1. Open the page, scroll to the bottom, click Edit page.
2. GitHub opens its editor on the page’s .md file. Make your change.
3. Click Commit changes…, write a one-line summary (see commit format), choose Commit directly to the main branch, click Commit changes.
4. Wait 1–2 minutes and reload the page.

If you want someone to review before it goes live, choose Create a new branch … and start a pull request at step 3 instead.

Option 2 — Add a new page

1. On GitHub, open the folder src/content/docs/<module>/ (e.g. mes).
2. Click Add file → Create new file, name it <slug>.md — lower case, hyphens, the same slug as the flow site when the function has a flow (e.g. defect-records.md).
3. Copy the skeleton from the page template, fill it in, commit.
4. Create the Vietnamese page with the same name in src/content/docs/<module>/ (Vietnamese is the root language; English lives under en/).

Option 3 — Many files or images (on your machine)

git clone https://github.com/NhatPD2000/Fine-chemical-All-in-one-Data.git
cd Fine-chemical-All-in-one-Data
npm install
npm run dev        # preview at http://localhost:4321
# ... edit files ...
npm run check      # checks: missing EN page, EN older than VI, duplicate BR codes, missing frontmatter
git pull --ff-only
git add <edited files>
git commit -m "test(mes/repair-rework): add Qty 1 edge case"
git push

Images: put them in an img/ folder next to the page, name them <slug>-<description>.png, insert with ![Description](./img/repair-rework-result-box.png). Keep images under 500 KB.

Two languages

Each page has a Vietnamese version (src/content/docs/…) and an English version (src/content/docs/en/…, same path).

• When you edit one, try to edit the other in the same commit.
• If you cannot translate, commit your language anyway. The checker lists pages whose EN version is older than VI so someone else can catch up.
• A page without an EN version shows the VI version on the EN site with a notice.

Commit message format

<type>(<module>/<slug>): <what changed>

Type	Use when
rule	Changing business rules, statuses, fields, messages (sections 3–6)
dev	Adding/editing Dev notes (section 7)
test	Adding/editing Test notes (section 8)
oq	Adding or settling open questions (sections 9–10)
docs	General pages, wording, new pages
i18n	Translating / syncing the EN version

Example: rule(mes/repair-rework): BR-RW-13 allow Re-plan when Scrap = 0 (Q-20261020-02).

Never put in the base

• Passwords, tokens, system login accounts.
• Original customer files (.pptx, .xlsx, .docx) — only note the file name and where it is stored.
• Personal data of customer employees.