MD generator
Tools → MD generator produces a repository’s standard Markdown files. One screen: pick a project, pick a file, generate.
Files it can produce
Section titled “Files it can produce”| File | Content |
|---|---|
README.md | What the project is, how to run it, how it is audited |
CONTRIBUTING.md | Branch, review and merge flow |
AUTHORS.md | The people who work on the repository |
SECURITY.md | How to report a vulnerability |
CODE_OF_CONDUCT.md | Expected behaviour and enforcement |
CHANGELOG.md | Notable changes per release |
Two modes
Section titled “Two modes”From template (default, free)
Section titled “From template (default, free)”No AI integration required. The content comes from your project’s real data:
- Project name, repository path and URL, default branch, primary language, Git provider
- The modules your package enables - the README’s “Architecture audit” section lists only the modules you actually use
- For
AUTHORS.md, the synced list from the Developers board, with service accounts excluded
Nothing unknown is invented. We cannot know your build command or your licence, so those become a visible > **TODO:** line. A confident wrong npm run build costs more than an obvious blank.
The template mode produces English only. A hand-written template can only cover the languages someone maintains, and a half-translated CONTRIBUTING is worse than a consistent English one - which is also the convention these files follow in public repos.
With AI (optional)
Section titled “With AI (optional)”This mode unlocks once the installation’s operator has set up an AI provider and allowed fix suggestions; workspaces do not bring their own key. The model receives the same facts the template uses, the rendered draft itself and a shallow slice of the repository: description, topics, root listing, a few manifest files (such as package.json, *.csproj, go.mod, truncated) and the existing README. Its job is to improve the prose, not to research the whole project. TODO lines are preserved.
One extra choice appears in this mode:
- Document language - en, tr, de, fr, es, ru, ar, az. English is the default: a maintainer whose panel is in Turkish usually still wants an English README.
The token cost is shown in the result panel, split into input and output. The provider bills it to the operator’s account; the model is the installation’s default.
Output
Section titled “Output”The result panel has preview and raw Markdown tabs, plus copy and download buttons. The badge next to the file name states which language it came back in.