Skip to content

EN Wiki Maintenance

Cavanshirpro edited this page Sep 19, 2026 · 1 revision

Wiki maintenance and change-impact mapping

English · Türkçe · Languages / Diller

Scope: JSON API Forge 0.5.1 · Source review: 17 September 2026 · Language: English

Maintaining this Wiki means updating user-visible contracts, examples, defaults and known limits, not merely changing a version badge. English and Turkish pages must stay aligned.

Information for the next version review

New version: 0.6.0
Branches to review: main, python-library, Editor, exampleApps
Pinned commit/tag if available: ...
Change scope: ...
Wiki pages needing particular attention: ...

Keep the previous package and maintenance/source-map.json to retain page-to-source dependencies. When changes are supplied in this conversation, old/new contracts can be compared and concrete page/example updates identified. This package does not create background monitoring.

Source change → page map

Changed source Pages to review
main/framework/config.py, schemas/* Projects/JSON, feature guides and affected model references
framework/cli.py CLI, installation, first API, init/migration examples
security.py, protection.py, api_models.py Authentication, tenants, proxy trust, errors and SDK examples
crud.py, mongo.py, db.py CRUD, MongoDB, databases/migrations and pagination
operations.py RPC, retries/idempotency and cluster boundaries
cache.py, rate_limit.py, events.py, media.py Matching operations guide and model fields
reload.py, factory.py, runtime.py Architecture, reload, readiness and deployment
editor_api.py, editor_identity.py, editor_database.py Remote Editor, control-plane HTTP/models and SDK contracts
python-library/json_api_forge/* SDK guides, signatures, retry/cluster examples
Editor/editor/src/GraphModel.cpp Node/compiler behavior and graph schema
Editor UI/settings Menus, shortcuts, workspace and preferences
Editor plugins/packaging Plugin API, ZIP limits, ABI and installers
Workflows/pyproject/CMake Support matrix, installation, build/test/release
exampleApps/app/* Catalog, example paths and related tutorials
LICENSE/policy documents License summary and official source links

Included maintenance tools

maintenance/source-map.json records page dependencies and baseline commits. maintenance/source-index.json stores Git blob IDs for tracked files. maintenance/review_changes.py compares newer refs and reports affected pages in both languages:

git -C /path/to/JSON-API-Forge fetch origin
python maintenance/review_changes.py --repo /path/to/JSON-API-Forge --output wiki-impact.md

The repository must contain all product-branch remote refs. The tool does not make network requests or write to GitHub. Repeated --ref main=origin/main arguments can override refs. The stored blob inventory permits comparison even if old commits disappear from history.

An unmatched changed file is not proof that documentation is unaffected: a new endpoint/property can change broader contracts. Unmatched files are reported separately.

Checklist for every update

  1. Pin all four new branch SHAs and compare stated versions with actual releases.
  2. Regenerate schema fields and public SDK signatures; document renamed/removed fields in migration guidance.
  3. Run tutorials in a clean environment.
  4. Check internal links, source paths, case sensitivity and English/Turkish page pairs.
  5. Update dependency maps, translation metadata and VERIFICATION.md.
  6. Publish through a normal Wiki Git commit without force-pushing.

Preserve page names where possible. If a rename is necessary, leave a short link at the old page and update Home, both contents pages and _Sidebar.md. maintenance/language-map.json identifies every English/Turkish pair. Updating a technical contract requires reviewing both members of the pair.

Publication

The Wiki lives in JSON-API-Forge.wiki.git, separately from the product repository. After saving an initial GitHub Home page, run WIKI-YAYINLA.bat or PUBLISH-WIKI.bat on Windows, or publish-wiki.sh on Linux/macOS. The tools publish both languages in one commit, preserve unrelated existing pages and do not merge product branches.

Read START-HERE.md or BASLA.md first. Existing Git identity and credential-manager authentication are used; no token is embedded in the script. A concurrent remote update can reject a non-fast-forward push; the local work copy is retained.

Sources and verification

This page describes the behavior at the pinned commits below. Recheck these contracts when upgrading.


English home · All English pages · Version maintenance

Clone this wiki locally