> For the complete documentation index, see [llms.txt](https://docs.layeronecloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.layeronecloud.com/contributing.md).
# Contributing
GitBook's **LayerOne LLC Docs** site is the authoring source for all LayerOne feature, setup, operational, and developer documentation. Git Sync automatically exports published changes to [LayerOne-LLC/Documentation](https://github.com/LayerOne-LLC/Documentation) on `main`. The `../LayerOne Docs` checkout is an export for reference and validation.
## Documentation workflow
1. Confirm that the connected **GitBook MCP** can access the **LayerOne LLC Docs** site in the **LayerOne LLC** organization before any project work. If access is missing, disconnected, unauthenticated, or denied, stop and ask the user to restore it. Do not fall back to local files, cached documentation, or direct website requests.
2. Read the relevant GitBook developer reference. Use the [Agent guide](/ai/agent-guide.md) to find the right page, and verify behavior against the affected code.
3. Create a GitBook change request. Add or edit the relevant pages through MCP as part of the feature task. Preserve numbered sections, rationale, permissions, failure cases, and invariants.
4. Keep the page hierarchy and internal links accurate. Preview or read back the draft, then merge the documentation change request to publish it.
5. Check GitBook's Git Sync status and the automatic export to GitHub. Report published documentation changes alongside code diffs.
Do not author documentation by editing synchronized GitHub files or manually committing/pushing the documentation repository. GitBook's change-request workflow and its automatic Git Sync are the intended publication path.
## GitBook configuration
The existing site publishes at [docs.layeronecloud.com](https://docs.layeronecloud.com) and is already connected to the documentation repository's `main` branch. Preserve the existing space identity and the `space-1` mapping key. GitBook manages the exported site mapping, Markdown pages, assets, and navigation. Configure Git Sync in GitBook; there is no separate website build in this repository.
The first sync failed because the repository's `gitbook-docs.yaml` was empty. GitBook subsequently exported a valid site configuration. Documentation is now created in GitBook itself, which supplies the content for the automatic export.
## Migrated content
The migration consolidates 100 existing source pages plus 13 navigation pages and this contributor guide. It includes the platform, application platform, CloudLinux node agent, Network Monitor, standalone monitoring agent, and pve-microvm. Source duplicates were removed from the code projects, which keep short README links, AI rules, and required legal/release metadata. Numbered sections, technical examples, rationale, media, and notices are preserved.
## Proxmox documentation checks
The documentation assertions formerly in `pve-microvm/tests/run-tests.sh` now travel with the documentation. Download the [documentation checker](https://github.com/LayerOne-LLC/Documentation/tree/main/untitled/.gitbook/assets/check-pve-docs.sh), export or check out the synced documentation, then run it from the directory containing `pve-microvm/`:
```sh
LAYERONE_DOCS_ROOT="$PWD" bash /path/to/downloaded/check-pve-docs.sh
```
Runtime checks stay in the code repository. Its release automation retains a small `RELEASE_NOTES.md` link to the detailed release notes in GitBook.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.layeronecloud.com/contributing.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.