Skip to content
Documentation

Keeping a Project in Step with Its Sources

updated

A project can follow other projects in the workspace. When someone edits a document in a followed project, Meldoc reads the documents in this project and flags each sentence the edit made false — a product guide that still names the old limit after the technical docs changed it, a support article that still describes a removed step.

This is for documentation no repository keeps current: product docs, support articles, RFCs and PRDs edited only by hand. Sources is switched on per workspace; if Sources is missing from the project settings, it is not switched on for yours.

Set it up

  1. Open Project settings of the project to keep current and choose Sources.
  2. Pick a project from the list. It is followed and saved at once.
  3. To stop following a project, select × next to it.

The project whose settings you are in is the one that gets checked; the projects it follows are the ones whose edits start a check. A chain works: support articles can follow product docs, which follow technical docs. A project follows up to ten others in its own workspace, never itself, and never in a cycle.

Only people who can change the project’s settings can change what it follows. Reading the documents with a model needs a workspace AI Provider key; without one, only the sentences Meldoc can settle by itself are flagged.

Where the results show up

A flagged sentence shows on its document as Source changed, doc didn’t, with a suggested fix, and in the Code check tab of the project overview. It closes when the sentence is edited or when you select All correct. Recent checks in the Sources section says what each check read and why one did not.

What’s next?

Documentation Review — The same kind of check for code changes in pull requests.

Creating and Configuring Projects — The rest of the project settings.