Docs/Guides/Project documentation

Guide: Project documentation

Nexora can draw on your project documentation — README, comments, configuration files — to give suggestions that match your architecture and your conventions.

ℹ️This works on every plan. The better structured your documentation, the sharper the suggestions.

How Nexora reads your project

When a workspace opens, Nexora indexes the documentation files it detects. That index is passed to the models as system context, so they understand your project before you even ask a question.

📄

README.md

Project description, install instructions, overall architecture.

⚙️

Config files

package.json, tsconfig.json, pyproject.toml — to understand your dependencies and conventions.

💬

JSDoc comments / docstrings

Nexora reads type annotations and function descriptions to enrich the context.

📁

AGENTS.md / CLAUDE.md

When present, these files take priority and steer the AI with your own instructions.

Configuring documentation in VS Code

You can choose which files Nexora reads from the extension settings:

{
  "nexora.context.includeReadme": true,
  "nexora.context.includePackageJson": true,
  "nexora.context.extraFiles": [
    "ARCHITECTURE.md",
    "docs/conventions.md",
    "docs/api-reference.md"
  ],
  "nexora.context.maxFileSize": 50000
}

💡Keep maxFileSize under 50,000 characters per file. Larger files are truncated automatically, which can cut out important information.

Recommended project structure

To get the most relevant suggestions, lay your documentation out like this:

my-project/

├── README.md ← Overview, stack, quick start

├── ARCHITECTURE.md ← Architecture decisions, patterns in use

├── docs/

│ ├── conventions.md ← Naming conventions, code style

│ ├── api-reference.md ← Endpoints, data types

│ └── glossary.md ← Domain-specific terms

├── src/

│ └── ...

└── package.json

Using @doc in the chat

In the chat panel you can reference a documentation file explicitly to pull it into your question:

@doc README.mdAdds your README as context for the question

@doc ARCHITECTURE.mdAdds your architecture file

@doc docs/conventions.mdAdds a documentation file of your own

💡Combine @doc and @file for very targeted questions: “@doc conventions.md @file src/utils/parser.ts — does this file follow our conventions?”

A concrete example

With a README that states your stack and conventions, Nexora adapts its suggestions:

Without project documentation

“Write a function to parse a CSV”

→ A generic suggestion in plain JavaScript

With the README indexed (stack: TypeScript + zod)

“Write a function to parse a CSV”

→ A TypeScript suggestion with zod validation, strict types and error handling consistent with your codebase

The .nexoraignore file

To keep files out of the index (secrets, large files, generated folders):

# .nexoraignore
node_modules/
dist/
.env*
*.min.js
coverage/
docs/internal/    # Confidential internal documentation

⚠️Nexora never reads .env or .env.* files by default, even without a .nexoraignore.

← Autocomplete Docs home →