okatana-php-sdk/mkdocs.yml at main · newfoundcodes/okatana-php-sdk · 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
site_name: Okatana PHP SDK
site_description: Complete PHP client library for the Okatana External API v1
site_url: https://example.invalid/okatana-php/
repo_name: newfoundcodes/okatana-php-sdk
repo_url: https://github.com/newfoundcodes/okatana-php-sdk
theme:
  name: material
  custom_dir: docs/overrides
  language: en
  font: false
  logo: assets/logo-256.png
  favicon: assets/favicon.ico
  palette:
    scheme: default
    primary: white
    accent: red
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.footer
    - navigation.path
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link

plugins:
  - search:
      lang: en

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

extra_css:
  - assets/stylesheets/okatana.css

extra_javascript:
  - assets/javascripts/okatana.js

extra:
  generator: false
nav:
  - Home: index.md
  - Getting started:
      - Installation: getting-started/installation.md
      - Configuration: getting-started/configuration.md
      - Quickstart: getting-started/quickstart.md
  - Guides:
      - Client architecture: guides/architecture.md
      - Authentication and scopes: guides/authentication.md
      - Requests and validation: guides/requests.md
      - Responses and models: guides/responses.md
      - Pagination: guides/pagination.md
      - Errors: guides/errors.md
      - Retries and rate limits: guides/retries.md
      - Security: guides/security.md
      - Testing integrations: guides/testing.md
      - Production operations: guides/production-operations.md
  - API:
      - Organizations: api/organizations.md
      - Projects: api/projects.md
      - Boards: api/boards.md
      - Tickets: api/tickets.md
      - Documents: api/documents.md
      - Notifications: api/notifications.md
  - Examples:
      - Use-case catalog: examples/index.md
      - Project bootstrap: examples/project-bootstrap.md
      - CI/CD release workflow: examples/cicd-release.md
      - Incident response: examples/incident-response.md
      - Document publishing: examples/document-publishing.md
      - Analytics reporting: examples/analytics-reporting.md
      - External ticket sync: examples/ticket-sync.md
  - Reference:
      - Endpoint matrix: reference/endpoints.md
      - Full OpenAPI contract: reference/openapi-contract.md
      - SDK surface: reference/sdk-surface.md
      - Enums and scopes: reference/enums.md
      - Low-level client: reference/low-level.md
      - Source alignment: reference/source-alignment.md
      - Troubleshooting: reference/troubleshooting.md