From 4498443df6e230f13b2814db814b4f047888eb95 Mon Sep 17 00:00:00 2001 From: Seongho Bae Date: Sun, 20 Sep 2026 05:05:55 +0900 Subject: [PATCH 1/3] docs: preserve public Inkspan landing page on canonical CI owner --- docs/index.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/index.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..e779b921 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,46 @@ +# Inkspan + +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ContextualWisdomLab/inkspan) + +Inkspan is a modular authoring surface for applications and AI systems, combining rich Markdown/HTML editing, collaboration primitives, deterministic persistence evidence, safe serialization, and Office document rendering. + +## Product responsibility + +- React + TipTap/ProseMirror Markdown and HTML WYSIWYG editing. +- Safe links and self-contained base64 raster images enforced across parsing, commands, collaboration, and serialization. +- SSR-safe hydration and host-controlled imperative APIs for AI insertion, persistence, and focus. +- Provider-neutral Yjs collaboration with host-owned transport, authorization, persistence, and lifecycle. +- Revision, transition, selection, and autosave evidence for conflict-aware host persistence. +- Offline multilingual typography and email-ready serialization. +- Network-free JSON-to-DOCX/XLSX/PPTX rendering through the separately installed Inkspan Office Python package. + +## Onboarding + +Install the React package and styles: + +```bash +pnpm add @contextualwisdomlab/cwl-editor react react-dom +``` + +Start with the [repository README](https://github.com/ContextualWisdomLab/inkspan#readme) for component usage, host APIs, security boundaries, collaboration, persistence evidence, migration routing, email output, and Office rendering. + +## Architecture and integration + +Inkspan owns deterministic editor/document semantics and reusable local evidence. Hosts retain authenticated authorization, tenant identity, durable persistence, transport, encryption, retention, audit policy, and cross-service workflow authority. + +Useful references include: + +- [Canonical documentation index](README.md) +- [Server rendering](server-rendering.md) +- [Safe hyperlink policy](link-security.md) +- [Accessibility](accessibility.md) +- [Design tokens](design-tokens.md) +- [Revision-guarded restore](revision-guarded-restore.md) +- [Selection lifecycle](selection-lifecycle.md) + +## Releases and verification + +Use the [release evidence authority](adr/0010-release-evidence-authority.md) and [release security contract](release-security.md) to determine what is shipped. Release only the exact integrated protected-main head after its version identity, artifact inventory and digests, package-consumer evidence, required test, security and accessibility gates, SBOM and provenance, formal review, and repository-protection evidence all pass. Missing, conflicting, stale, or unverified evidence fails closed; a package release or green checks alone are insufficient. This source page is only a publication prerequisite; GitHub Pages should be treated as live only after repository settings and the published HTTPS endpoint are verified. + +- [Repository](https://github.com/ContextualWisdomLab/inkspan) +- [Ask DeepWiki](https://deepwiki.com/ContextualWisdomLab/inkspan) From 2c738ffd114eab0811ab87ff525cf858442c75b0 Mon Sep 17 00:00:00 2001 From: Seongho Bae Date: Sun, 20 Sep 2026 08:05:43 +0900 Subject: [PATCH 2/3] docs: add canonical DeepWiki badge to Inkspan README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index f5640202..8559bad5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Inkspan +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ContextualWisdomLab/inkspan) + > **Inkspan** ([inkspan.io](https://inkspan.io)) is the product. Repository: > `ContextualWisdomLab/inkspan`. npm package: > `@contextualwisdomlab/cwl-editor`. From bb6cecd5f45b3837bedae1836566c91a2631c949 Mon Sep 17 00:00:00 2001 From: Seongho Bae Date: Thu, 1 Oct 2026 10:35:55 +0900 Subject: [PATCH 3/3] docs(release): distinguish proposed evidence ADR --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index e779b921..fe126afa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -40,7 +40,7 @@ Useful references include: ## Releases and verification -Use the [release evidence authority](adr/0010-release-evidence-authority.md) and [release security contract](release-security.md) to determine what is shipped. Release only the exact integrated protected-main head after its version identity, artifact inventory and digests, package-consumer evidence, required test, security and accessibility gates, SBOM and provenance, formal review, and repository-protection evidence all pass. Missing, conflicting, stale, or unverified evidence fails closed; a package release or green checks alone are insufficient. This source page is only a publication prerequisite; GitHub Pages should be treated as live only after repository settings and the published HTTPS endpoint are verified. +Use the [release security contract](release-security.md) for current release requirements. The [release evidence authority ADR](adr/0010-release-evidence-authority.md) is Proposed reference material until approved, not current release authority. Release only the exact integrated protected-main head after its version identity, artifact inventory and digests, package-consumer evidence, required test, security and accessibility gates, SBOM and provenance, formal review, and repository-protection evidence all pass. Missing, conflicting, stale, or unverified evidence fails closed; a package release or green checks alone are insufficient. This source page is only a publication prerequisite; GitHub Pages should be treated as live only after repository settings and the published HTTPS endpoint are verified. - [Repository](https://github.com/ContextualWisdomLab/inkspan) - [Ask DeepWiki](https://deepwiki.com/ContextualWisdomLab/inkspan)