Documentation Status

🚀Documentation Status

Auto-checked for v2.1.2

Identify the Custy release represented by this site and decide when release-specific verification is needed.

Commandcusty

📦Category

Reference

🚀Quick Command

custy --version

---

documentation baselinerelease alignmentmaintenance

---

🏷️

Documentation Baseline

Custy v2.1.2

✅

Last Reviewed

September 11, 2026

✨

Languages

English and Indonesian

⚙️

Freshness Mode

Automatic · SemVer

Current baseline

These pages describe Custy v2.1.2 and were last reviewed against the active source on September 11, 2026. The date records a deliberate documentation review; it is not an automatic Git edit date or deployment timestamp.

ℹ️Remote tags are checked at build time

The portal runs git ls-remote --tags --refs when Docusaurus starts or builds. It does not query GitHub from each visitor's browser. The deployed result stays unchanged until the documentation site is built again.

Custy uses automatic SemVer detection for its current repository tag strategy.

---

Compare Your Installed Version

Show the installed Custy version

bash

custy --version

• If the command reports 2.1.2, this documentation is the matching baseline.
• If it reports an older version, use that version's release notes and source tag to identify features that were not available yet.
• If it reports a newer version, review the releases published after v2.1.2 for new commands, options, configuration, behavior changes, and fixes.
• For pre-release or post-release identifiers, compare the complete version, including markers such as alpha, beta, rc, dev, or post.

Use the Custy releases and the v2.1.2 source snapshot as release-specific references.

---

Freshness States

✨Features

✅Current

The documented version equals the latest compatible remote tag. The global notice is hidden to avoid repeating non-actionable information.

⚠️Outdated

A newer compatible tag exists. A warning appears at the top of every affected project page before readers follow version-sensitive instructions.

ℹ️Preview

The documented version is newer than the latest compatible remote tag. An informational notice identifies the documentation as a preview.

⚙️Unknown

The latest release could not be verified and no current fallback was selected. A neutral notice asks readers to check the release list.

---

Configuration Reference

Freshness settings live in the project entry in src/data/projects.ts. They configure the documentation portal itself; they are not Custy CLI settings and do not belong in .config/custy/config.toml.

📋Shared documentation fields

Property	Type	Description	Default	Required
version	string	Normalized application version represented by these pages, without requiring a v prefix.	-	Yes
versionTag	string	Repository tag intended to represent the documented release, such as v2.1.2.	-	Yes
lastReviewed	YYYY-MM-DD	Date when maintainers deliberately reviewed the documentation against source.	-	Yes
releaseUrl	URL	Release page for the documented baseline.	-	Yes
statusPath	site path	Locale-independent route to this documentation-status page.	-	Yes
freshness.mode	manual | auto	Select maintainer-controlled status or build-time remote-tag detection.	-	Yes

📋Automatic-mode fields

Property	Type	Description	Default	Required
repositoryUrl	Git URL	Remote queried with git ls-remote. Public HTTPS URLs are the simplest choice for CI.	-	Yes
tagFormat	semver | pep440	Version grammar used to validate and order tags. Custom formats are intentionally unsupported.	-	Yes
releasesUrl	URL	Optional release-list link shown when readers need another version.	-	No
includePrereleases	boolean	Include alpha, beta, rc, and development tags when selecting the latest version. PEP 440 post releases remain stable candidates.	false	No
timeoutMs	number	Remote-query timeout from 1000 through 60000 milliseconds.	10000	No
fallbackStatus	current | unknown	Status used only when automatic verification fails. Use current only when maintainers accept that explicit fallback.	unknown	No

Automatic mode

src/data/projects.ts

documentation: {
  version: "2.1.2",
  versionTag: "v2.1.2",
  lastReviewed: "2026-09-11",
  releaseUrl: "https://github.com/devalltect00/Custy/releases/tag/v2.1.2",
  statusPath: "/docs/custy/reference/documentation-status",
  freshness: {
    mode: "auto",
    repositoryUrl: "https://github.com/devalltect00/Custy.git",
    tagFormat: "semver",
    releasesUrl: "https://github.com/devalltect00/Custy/releases",
    includePrereleases: false,
    timeoutMs: 10_000,
    fallbackStatus: "unknown",
  },
}

Manual mode

Use manual mode for custom version formats, repositories that cannot be reached from the build environment, or projects whose release status requires human judgment.

src/data/projects.ts

freshness: {
  mode: "manual",
  status: "current", // current | outdated | preview
  latestVersionTag: "custom-release-42", // optional
}

---

Tag Selection Rules

1. Query direct remote tag refs without cloning the repository.
2. Remove refs/tags/, discard peeled ^{} duplicates defensively, and preserve the original tag for display.
3. Accept the conventional optional v prefix.
4. Ignore tags that do not match the configured semver or pep440 grammar.
5. Exclude prereleases unless includePrereleases is true.
6. Sort compatible tags with the selected grammar rather than lexical text order. For example, 1.10.14 correctly sorts after 1.10.9.
7. Compare the normalized latest version to the documented baseline.

Custom tag grammars are not accepted in automatic mode. Select manual mode instead of approximating a custom ordering rule.

---

Failure Handling

• Invalid maintainer configuration, including an unsupported format, invalid baseline, missing remote URL, or timeout outside the supported range, stops the build with an actionable error.
• Missing Git, network failures, authentication failures, and timeouts do not silently claim that documentation is current. The plugin uses fallbackStatus and prints a build warning.
• A successful query with no compatible tags produces the same fallback behavior with the diagnostic code no-compatible-tags.
• Remote error details remain in build logs; raw process errors are not exposed to documentation visitors.
• The remote query runs once per configured project per Docusaurus process, not once per page.

For private repositories, ensure the build environment can authenticate the configured Git URL. Do not place credentials or tokens directly in src/data/projects.ts.

---

Deployment and Release Automation

Automatic detection is evaluated when yarn start, yarn build, or another Docusaurus command loads the plugin. A new Custy tag does not change an already deployed static site until Devalltect Docs is rebuilt.

The current Pages workflow rebuilds on pushes to the documentation repository and manual workflow runs. A later integration can trigger a documentation build from a Custy release through repository_dispatch, or a scheduled workflow can periodically recheck tags. Those workflow triggers are independent of the freshness resolver.

---

What the Baseline Covers

✨Features

💻Public CLI

Documented command names, options, output, side effects, and supported public pipeline profiles are aligned with v2.1.2.

⚙️Configuration

Configuration sections and properties are based on the v2.1.2 templates and active resolution behavior.

🔄Developer Internals

Architecture, extension, testing, and pipeline material reflects the source reviewed for the v2.1.2 documentation baseline.

⚠️Known Limitations

Experimental, internal-only, loaded-only, or currently limited behavior is identified on the affected pages.

---

Documentation Maintenance

Maintainers should update the central baseline when a Custy release changes documented commands, options, configuration, workflows, output, architecture, or other user-visible behavior. A complete synchronization should include:

1. Review the new release tag and active source behavior.
2. Update affected English pages.
3. Apply the same technical changes to the Indonesian pages while preserving command names, options, paths, configuration keys, and code exactly.
4. Change the baseline version, tag, release URL, and last-reviewed date.
5. Confirm tagFormat still matches the repository's SemVer strategy.
6. Run the freshness tests, type checking, and production builds for both locales.

The global notice reads one central metadata entry and the build-time resolver result. It remains hidden when documentation is current and appears only when readers need preview, outdated, or verification-failure context.