Skip to content

docs(wikg): add .wikg archive standard#111

Merged
Moskize91 merged 2 commits into
mainfrom
codex/wikg-standard-doc
Jul 14, 2026
Merged

docs(wikg): add .wikg archive standard#111
Moskize91 merged 2 commits into
mainfrom
codex/wikg-standard-doc

Conversation

@Moskize91

Copy link
Copy Markdown
Contributor

Summary

  • add a public .wikg archive standard covering ZIP layout, required and optional entries, cover handling, compatibility, and versioning
  • link the standard from the English and Chinese README agent sections

Verification

  • pnpm run lint:fix

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Adds docs/wikg-standard.md, documenting the .wikg ZIP archive layout, required and optional entries, manifest and SQLite contracts, validation, extraction safety, compatibility behavior, semantic layers, and versioning rules. Updates the English and Chinese READMEs with links to this standard.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title follows the required type(scope): subject format and clearly matches the documentation-focused change.
Description check ✅ Passed The description summarizes the new .wikg standard and README links, which are directly related to the changeset.
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch codex/wikg-standard-doc

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/wikg-standard.md`:
- Around line 47-62: Align the `.wikg-mutation-token` contract by updating the
reader’s parsing logic to require the exact two-line UTF-8 payload with a
trailing newline, matching `docs/wikg-standard.md`; alternatively, if preserving
the current reader behavior, revise the specification to allow payloads without
the trailing newline. Keep token validation and archive mutation handling
unchanged.

In `@README.md`:
- Around line 278-279: Align the `.wikg` Archive Standard link descriptions in
README.md lines 278-279 and README_zh-CN.md lines 278-279 with the standard’s
actual scope by removing the unsupported URI and automation rules references, or
add corresponding sections to the standard documentation if that is intended.
Apply the same scope correction consistently in both English and Chinese
descriptions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 10231efc-62e4-4593-a456-2f33df10ca5c

📥 Commits

Reviewing files that changed from the base of the PR and between 0352f95 and 990cbdf.

📒 Files selected for processing (3)
  • README.md
  • README_zh-CN.md
  • docs/wikg-standard.md

Comment thread docs/wikg-standard.md
Comment thread README.md Outdated
@Moskize91 Moskize91 changed the title docs: add .wikg archive standard docs(wikg): add .wikg archive standard Jul 14, 2026
@Moskize91 Moskize91 merged commit 82a75c4 into main Jul 14, 2026
3 checks passed
@Moskize91 Moskize91 deleted the codex/wikg-standard-doc branch July 14, 2026 05:50
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.

1 participant