Documentation Introduction

Start here

Introduction

One home for shared knowledge, with relevant context in each repository.

Mindslice connects the home-repo pattern to the repositories where you build. Keep shared product context, architecture, decisions, and working conventions in a homebase, use it to coordinate across projects, and make the relevant Markdown available inside each connected repository.

Your agent reads ordinary local Markdown. You keep using the tools you know, with less explaining and a better starting point.

Mindslice is currently an experimental CLI and local service. These guides describe the local workflow available today, not every feature in the longer-term product vision.

The idea in a minute

Most projects need knowledge that doesn’t live neatly in their source code. Why was the system designed this way? What does the product promise? Which conventions should a new feature follow?

A homebase gives that knowledge a durable home outside any single application repository. Mindslice makes a selected view of it available inside connected projects.

  1. Gather your knowledge. Use Markdown in a local homebase folder.
  2. Connect your projects. Choose which knowledge belongs in each one.
  3. Build with context. Let your coding agent read the relevant pages before it makes changes.

Three concepts to know

ConceptWhat it means
HomebaseThe canonical folder of knowledge. It can be a plain directory or a Git repository.
ProjectAn application directory that uses knowledge from one or more homebases.
Context viewA generated, project-local view of the selected Markdown. It is not a second source of truth.

Keep the homebase separate from your application code. Multiple projects can connect to the same knowledge without each maintaining its own copy.

A home repo, with project-aware context

The home-repo pattern gives agents a shared starting point outside any one application: common documentation, agent guidance, and references to other repositories. The pattern works with ordinary Git and Markdown; it does not require Mindslice.

Mindslice adds two local connections to that approach:

  • From the homebase to the code: list known projects and resolve their local checkouts before planning work across repositories.
  • From the code to the knowledge: each connected project gets a selected view of the same canonical Markdown.

You can plan from the homebase or start directly in an application with its selected context. Your agent remains responsible for the work. Mindslice does not launch agents, clone missing applications, or grant access to repositories.

See using a home repo and the agent workflow.

Built around your files

Mindslice doesn’t require a proprietary document format or a hosted retrieval service for its core local workflow. Your knowledge stays readable as Markdown on your machine.

Use Git when you want version history and collaboration. A Git remote is optional; the current CLI does not implement ongoing remote synchronization or publishing. Manage those operations separately with your normal Git workflow.

Project selection is for relevance, not access control. Don’t use include/exclude rules as a confidentiality boundary.

Find your starting point

  • Get started — install Mindslice and connect your first project.
  • Homebases — organize the knowledge that outlives a single repository.
  • Project context — understand selection and generated context views.
  • Working with agents — bring shared knowledge into your daily workflow.
  • CLI reference — a practical reference for the local commands.