Skip to content

Commit 54e94bb

Browse files
docs: migrate AsciiDoc to MkDocs Material, add Vale linting
- Create mkdocs.yml with golden config (blue/light blue theme, full extensions, Mermaid, drawio) - Convert 26 AsciiDoc files to Markdown across getting-started/, tools/, operations/, reference/, standards/ - Create index.md homepage and contributing.md - Add deploy-docs.yml workflow (Python 3.12, mkdocs-drawio) - Move draw.io diagrams to docs/assets/diagrams/ - Archive all .adoc files to docs/_archived_adoc/ - Add .vale.ini and styles/Microsoft/ (44 rules) for Vale linting - Fix broken anchor links in badge-standards.md
1 parent 9aa924e commit 54e94bb

108 files changed

Lines changed: 4945 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy-docs.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
paths:
7+
- "docs/**"
8+
- "mkdocs.yml"
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Python
28+
uses: actions/setup-python@v5
29+
with:
30+
python-version: "3.12"
31+
32+
- name: Install dependencies
33+
run: |
34+
pip install mkdocs-material pymdown-extensions mkdocs-drawio
35+
36+
- name: Build MkDocs site
37+
run: mkdocs build --strict
38+
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: site/
43+
44+
deploy:
45+
environment:
46+
name: github-pages
47+
url: ${{ github.event.repository.html_url }}
48+
runs-on: ubuntu-latest
49+
needs: build
50+
steps:
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v4

.vale.ini

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
StylesPath = styles
2+
MinAlertLevel = suggestion
3+
[*.md]
4+
BasedOnStyles = Vale, Microsoft
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)