-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add public Inkspan landing page #396
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
seonghobae
wants to merge
3
commits into
main
Choose a base branch
from
docs/public-surface-metadata
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Inkspan | ||
|
|
||
| [](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) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.