Skip to content

bcdock/docs

Repository files navigation

BCDock Docs

Source for docs.bcdock.io - the documentation for BCDock, the managed platform for Microsoft Dynamics 365 Business Central environments on Azure.

Built with Mkdocs Material, served via GitHub Pages.


Read the docs

The published site is at docs.bcdock.io:

  • Quickstart - install the bcdock CLI, create your first environment, build an AL extension.
  • CLI - reference for every bcdock verb.
  • Guides - AL extension dev loop, GitHub Actions, Claude Code integration, data export, account deletion.
  • Reference - BC version coverage, current limitations.
  • Security - posture, data handling, disclosure process.
  • Architecture - how BCDock works internally (environments, pools, hibernation, images).

GitHub also renders these pages directly under docs/ in this repo if you'd rather read them at the source.

Build the site locally

make setup    # one-time bootstrap (creates .venv via uv)
make serve    # live-reload at http://localhost:8000
make build    # mkdocs build --strict (the same gate CI uses)

--strict turns broken links and missing nav entries into errors.

Prerequisite: uv. If uv isn't on PATH:

curl -LsSf https://astral.sh/uv/install.sh | sh

Contribute

See CONTRIBUTING.md. Short version:

  • Typos, broken links, factual errors, missing examples -> open an issue.
  • Anything bigger -> open an issue describing the change.
  • Security issues -> SECURITY.md, not a public issue.

PRs submitted here are auto-closed; they would be overwritten on the next sync. The auto-close is structural, not personal.

Licence

MIT. See LICENSE.

Related repositories

About

Source for docs.bcdock.io - the BCDock documentation site. Force-push mirror; contributions via issues (see CONTRIBUTING.md).

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors