Skip to content
DocumentationDevelopmentEngine ccf7d03f

Engine and documentation changes share the same public contracts, but their source ownership is separate. Change engine behavior in InnoEngine and reader-facing documentation in InnoEngine.Docs.

The applicable rulebooks are the authority for repository changes. This Manual explains the engine rather than maintaining a second copy of those rules.

Use the engine’s unified validation plan for code and contract changes. Preserve the first failure and record why a check is rerun. Missing, canceled, skipped, or unavailable checks are not successful evidence.

Validate an engine change explains planning, native prerequisites, isolated execution and result reuse. Use the test-suite reference to find the behavior you are changing.

Documentation builds consume pinned project/API facts. Editing prose or website presentation should not prepare a native engine product. Executable examples still require the actual references and API surface they claim to use.

Follow example validation to declare host or script context and compile the exact code returned by the canonical documentation snapshot.

Compile scripts and generate IDE projects to prepare the actual script references without Native product preparation.

Maintain API XML with engine changes. After a human master merge, independent export synchronizes source facts and XML-managed prose into Docs draft. Tutorials and Manual pages are maintained separately. A human draft-to-main merge publishes the validated website; no paired engine PR metadata is required.

Maintain API documentation explains per-type/member XML and manual ownership, script scopes and non-blocking editorial reminders.

Publish documentation from draft explains previews, human release merges, GitHub validation, GitHub Pages deployment and failure diagnostics.

The InnoEngine logo was designed by xdzzyq. Its separate branding license applies to the logo and its derivatives; it is not covered by the engine’s Apache-2.0 source license.