Help make the docs better
Fix a typo, clarify a setup step, or add a guide with a pull request on GitHub.
The documentation lives in the public convergesense-docs repository. Each article is a plain Markdown file in pages/. You do not need access to the ConvergeSense application repository to contribute.
Make a quick correction
- Choose Edit this page on GitHub at the bottom of an article.
- Sign in to GitHub and edit the Markdown file. GitHub can create a fork for your changes.
- Preview your correction and describe what you changed.
- Open a pull request for a maintainer to review.
Small corrections are welcome. For a larger guide, start with a GitHub issue to agree on the scope.
Write an article
Create a .md file in pages/ using a lowercase, hyphenated name. Its path becomes the URL: pages/engines.md is served at /docs/engines.
Start with YAML frontmatter:
---
title: A clear, useful title
description: One sentence explaining what the reader will learn.
section: Get started
order: 3
---
Use ## for main sections and ### for subsections. The site generates the page title from frontmatter, the sidebar from the section and order, and the table of contents from your headings.
Supported sections are Get started, Connect your systems, Work with agents, Reference, and Community. Add an optional label for a shorter sidebar title.
Use ordinary Markdown
Write paragraphs, lists, tables, fenced code blocks, and blockquotes. Use relative .md links between articles so they work in GitHub previews and on the website.
Read the [Engine guide](engines.md).
## Before you start
- Use an owner account.
- Confirm the Engine is online.
> Keep the original job ID when checking progress.
Raw HTML and executable MDX are not supported. Use synthetic examples and placeholders for identifiers; never include secrets, customer records, or raw device output.
Check your changes
From a clone of the docs repository:
npm ci
npm run check
The checks validate article metadata and internal links. They also run on pull requests. Use GitHub's Markdown preview to review your writing.
Review and publication
A maintainer reviews corrections before merging. The website publishes a pinned snapshot of the docs repository, so a merged change appears after the next docs sync and site deployment.
For sensitive security reports, contact security@convergesense.com instead of opening a public issue.