Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Docs checks

on:
pull_request:
push:
branches: [main]

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- run: npm ci
- run: npm run check
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing to the Basic Memory docs

Keep documentation task-oriented, current, and explicit about whether a workflow uses Basic Memory Cloud or the open-source local project.

## Before opening a pull request

- Verify CLI commands and MCP parameters against the current `basic-memory` source or generated help.
- Verify Cloud settings, permissions, roles, billing behavior, and screenshots against the current application.
- Verify third-party integrations against the provider's official documentation.
- Avoid current-page claims tied to a release number. Put historical behavior in What's New, Changelog, or a migration page.
- Use screenshots only when they clarify a UI step that text cannot describe reliably.
- Add maintained screenshots to `docs/screenshots.json`.
- Preserve a redirect when deleting or renaming a published page.
- Run `npm run check`.

## Writing style

- Lead with the task or decision the reader is trying to complete.
- Keep Quickstarts short; link to deeper reference pages.
- Describe shipped behavior only. Label historical material as historical.
- Prefer durable names and concepts over exact button positions when third-party interfaces change frequently.
- Do not frame Basic Memory only as expanded model memory. It is a shared knowledge base for documents, workflows, projects, research, creative work, humans, AI tools, agents, and teams.
9 changes: 9 additions & 0 deletions app/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,22 @@ export default defineAppConfig({
},
contentNavigation: {
slots: {
link: 'items-start',
linkLeadingIcon: 'size-4 mr-1',
linkTitle: 'min-w-0 flex-1 overflow-visible text-clip whitespace-normal break-words leading-5',
linkTrailing: 'hidden',
},
defaultVariants: {
variant: 'link',
},
},
contentToc: {
slots: {
link: 'items-start py-1.5',
linkText: 'overflow-visible text-clip whitespace-normal break-words leading-5',
indicator: 'hidden',
},
},
pageLinks: {
slots: {
linkLeadingIcon: 'size-4',
Expand Down
Loading
Loading