The documentation now lives in the wickra-lib/wickra-docs VitePress repo and
will deploy to docs.wickra.org. Rewrite every tracked, user-facing wiki link
in the main repo to the new canonical site:
- docs/README.md, CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md
- bindings/{node,python,wasm}/README.md, examples/wasm/README.md
- repo-metadata.toml: wiki_url/wiki_git -> docs_url/docs_git
Page paths map 1:1 to VitePress clean URLs (e.g. /wiki/Quickstart-Rust.md ->
docs.wickra.org/Quickstart-Rust). The sync-about.yml wiki-sync step is left
untouched on purpose: it stays until the docs site is live (tracked as P8.3).
The GitHub wiki itself is not deleted yet for the same reason.
55 lines
1.9 KiB
TOML
55 lines
1.9 KiB
TOML
# Single source of truth for repo-level identity (org slug, maintainer email,
|
|
# canonical URLs). The audit workflow `.github/workflows/sync-metadata.yml`
|
|
# parses this file and fails CI if any tracked file disagrees.
|
|
#
|
|
# Do NOT edit downstream files by hand for these fields. Edit here, then run
|
|
# the workflow locally to spot drift, fix the downstream files until the
|
|
# audit is green.
|
|
|
|
[repo]
|
|
org = "wickra-lib"
|
|
name = "wickra"
|
|
url = "https://github.com/wickra-lib/wickra"
|
|
docs_url = "https://docs.wickra.org"
|
|
docs_git = "https://github.com/wickra-lib/wickra-docs"
|
|
issues_url = "https://github.com/wickra-lib/wickra/issues"
|
|
discussions = "https://github.com/wickra-lib/wickra/discussions"
|
|
security_url = "https://github.com/wickra-lib/wickra/security/advisories/new"
|
|
|
|
[maintainer]
|
|
# `handle` is the natural-person credit shown in package manifests; it does
|
|
# not move with the GitHub org transfer. `github` is the org @-mention slug
|
|
# used in CODEOWNERS and prose.
|
|
handle = "kingchenc"
|
|
email = "wickra.lib@gmail.com"
|
|
github = "wickra-lib"
|
|
|
|
[badges]
|
|
codecov_repo = "wickra-lib/wickra"
|
|
ci_workflow = "ci.yml"
|
|
|
|
[audit]
|
|
# Forbidden substrings that must not appear anywhere in the repo outside the
|
|
# allowlist below. These are the pre-migration values; if any one of them
|
|
# resurfaces in source, the audit workflow fails.
|
|
forbidden = [
|
|
"kingchenc/wickra",
|
|
"kingchencp@gmail.com",
|
|
]
|
|
|
|
# Paths that are exempt from the forbidden-substring scan. Historical
|
|
# CHANGELOG sections keep their prose unchanged; auto-generated and ignored
|
|
# folders never reach the repo but are listed for parity with `.git/info/exclude`.
|
|
allowlist = [
|
|
"target/",
|
|
"node_modules/",
|
|
"fuzz/target/",
|
|
".venv/",
|
|
"Cargo.lock",
|
|
"package-lock.json",
|
|
"bindings/node/index.js",
|
|
"bindings/node/index.d.ts",
|
|
"repo-metadata.toml",
|
|
".github/scripts/sync-metadata.py",
|
|
]
|