eng-playbook/mkdocs.yml at main · gramnegrod/eng-playbook · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
site_name: Engineering Playbook
site_description: Company Engineering Playbook - Living docs-as-code
site_author: Engineering Team
site_url: https://gramnegrod.github.io/eng-playbook/

repo_name: gramnegrod/eng-playbook
repo_url: https://github.com/gramnegrod/eng-playbook

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Overview: 00-overview.md
  - Core Principles:
      - Culture & Principles: 01-culture-principles.md
      - Project Lifecycle: 02-project-lifecycle.md
  - Development Practices:
      - Branching Strategy: 03-branching-strategy.md
      - Code Review: 04-code-review.md
      - Testing Standards: 05-testing-standards.md
  - Technical Infrastructure:
      - CI/CD Setup: 06-cicd-setup.md
      - Security Controls: 07-security-controls.md
      - Architecture Guidelines: 08-architecture-guidelines.md
  - Knowledge & Quality:
      - Documentation Standards: 09-documentation-standards.md
      - Observability: 10-observability.md
      - External Research Protocol: 11-external-research-protocol.md
  - Reference:
      - Glossary & Style Guide: 12-glossary-style-guide.md
      - References: references.md
  - Templates:
      - RFC Template: ../templates/rfc_template.md
      - PR Checklist: ../templates/pr_checklist.md
      - External Research: ../templates/external_research_template.md
      - ADR Template: ../templates/adr_template.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/gramnegrod