Project setup
Knowledge docs
Soffi keeps two kinds of written context beside your code. Knowledge docs describe the codebase itself, one set per repository. Company knowledge describes your company, your users and your brand, once for the whole Organization. Soffi reads both when it works in a Workspace, so it starts from what your team already knows instead of rediscovering it every time.
Knowledge docs
When a repository is imported, Soffi reads it and writes a set of reference documents about it. Open the Project from Projects in the left rail and choose Knowledge docs to read them. Each one covers a single topic:
| Document | What it covers |
|---|---|
| Index | The entry point, listing the other documents |
| Architecture | What the app does, its tech stack, and its service architecture |
| Design | Design system, CSS framework, component library and tokens |
| Deployment | How the app builds and runs: services, ports, networking, startup scripts |
| Coding Standards | Linter configs, conventions and code style patterns |
| CI Workflows | The CI pipeline and its workflows |
| PR Template | The pull request template, from the repository or GitHub |
| Project Structure | Service layout, monorepo mapping and package boundaries |
| Authentication | Identity providers, user provisioning, sessions and test sign-in |
Documents that haven't been written yet are still listed, so you can see what's missing. If setting up the docs didn't finish, the page says so and offers Retry. If a Project has no knowledge docs at all, Create knowledge docs starts them.
Keeping them current
You don't need to maintain them. As the code changes, Soffi keeps the documents up to date on its own, the same way it keeps Workspaces current. See Staying up to date.
When you want a document refreshed now, you can still do it by hand:
- Generate on a single document rewrites it from the current code, for example right after a new CI workflow or a different sign-in provider lands.
- Review all, on the Advanced tab, has Soffi re-read every document for quality and consistency and regenerate the ones that need it. It uses AI credits.
Editors, Admins and Owners can generate and review documents.
Company knowledge
Company knowledge lives under Settings, in Company knowledge, and applies across every Project in your Organization. It's where you tell Soffi what the code can't: who your users are, what value you offer them, what stage your company is at, your brand tone, and where users turn when something breaks. There's also room for anything else Soffi should know, and a Brand documents tab for uploading brand material.
Admins also see the main questions in a prompt on the Workspaces page until they answer or dismiss it. Editors and above can edit the answers at any time, and each answer shows who last updated it.