Vicode docs

What vicode is

vicode is a product library. It helps a visitor understand what a product is, whether it is installable, downloadable, demo-ready, docs-ready, or showcase-only, and what to do next.

Project pages hold the public product story and proof. Project docs hold the stable reference material. Packages and downloads stay close to the work when they help someone install, reuse, or evaluate it. Collections group related projects, tools, and references into clearer capability bundles.

Start here

Use these docs when you need the platform model, not the details of one specific build.

• Read Publishing to understand the supported ways to add a project into vicode.
• Read Project pages to understand how the public product surface should be structured.
• Read Codex Voice for the public product story behind the featured voice demo.
• Read Notes, comments, and voice memos to understand the active trail around a project.
• Read API and CLI if you are publishing from scripts, local folders, or agents.
• Read FAQ for practical edge cases.

Platform docs versus project docs

Platform docs explain how vicode works: publishing, access states, notes, comments, API usage, install/download expectations, and workflow patterns.

Project docs explain one build: setup, architecture, usage, constraints, and current direction. Keep stable project reference material at /p/[slug]/docs/... and use the project page itself for the public overview, availability, proof, and active trail.

Core objects

Projects are the main unit. Notes, build-log updates, comments, voice memos, docs, demos, and access settings all attach to a project.

• Projects are the software product, tool, library, site, or system.
• Build log entries capture milestones, releases, blockers, and setbacks.
• Notes are faster entries for ideas, blockers, and decisions.
• Voice memos attach audio to notes when writing is too slow.
• Kits package reusable starters, bundles, templates, or downloadable assets.
• Collections group projects, kits, references, and solution bundles.

Install, use, or contact

Not every project is installable or downloadable. vicode keeps availability explicit so the page can tell you whether something is:

• installable
• downloadable
• demo available
• docs available
• source available
• private / showcase-only
• custom setup available

That gives a visitor a clearer next step before they install something, read the docs, or reach out to discuss adapting it.