Skip to content

Commit fbf130e

Browse files
kyleconroyclaude
andauthored
Make docs/ a pure Markdown content directory (#4583)
Remove the Read the Docs and Sphinx configuration (.readthedocs.yaml, conf.py, requirements.txt, Makefile, theme templates and static assets) along with the docs pip ecosystem in dependabot and the .readthedocs.yaml entries in workflow paths-ignore lists. Port the three remaining reStructuredText files to Markdown: index.rst becomes index.md, and language-support and using-go-and-pgx are now GitHub-flavored Markdown using alert-style admonitions. Links that pointed at .rst files now point at their .md replacements. Add docs/toc.yaml, which declares the navigation order previously held in index.rst's toctree directives: every page appears exactly once, either in a titled section or in the unlisted set. This file is the contract a docs site consumer reads, and a future Go-based linter will enforce it. Claude-Session: https://claude.ai/code/session_013XDcHxZk9UzfzMLayG66Zq Co-authored-by: Claude <noreply@anthropic.com>
1 parent eb76767 commit fbf130e

24 files changed

Lines changed: 255 additions & 515 deletions

.github/dependabot.yml

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,4 @@ updates:
1717
directory: "/"
1818
schedule:
1919
interval: "daily"
20-
- package-ecosystem: "pip"
21-
directory: "/docs"
22-
schedule:
23-
interval: "daily"
24-
ignore:
25-
# sphinx-rtd-theme does not support the latest versions of docutils and
26-
# sphinx
27-
- dependency-name: "docutils"
28-
- dependency-name: "sphinx"
29-
groups:
30-
production-dependencies:
31-
dependency-type: "production"
32-
development-dependencies:
33-
dependency-type: "development"
3420

.github/workflows/buf.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ on:
33
pull_request:
44
paths-ignore:
55
- 'docs/**'
6-
- '.readthedocs.yaml'
76
jobs:
87
build:
98
runs-on: ubuntu-latest

.github/workflows/ci-kotlin.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@ on:
55
- main
66
paths-ignore:
77
- 'docs/**'
8-
- '.readthedocs.yaml'
98
pull_request:
109
paths-ignore:
1110
- 'docs/**'
12-
- '.readthedocs.yaml'
1311
jobs:
1412
build:
1513
if: false

.github/workflows/ci-python.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@ on:
55
- main
66
paths-ignore:
77
- 'docs/**'
8-
- '.readthedocs.yaml'
98
pull_request:
109
paths-ignore:
1110
- 'docs/**'
12-
- '.readthedocs.yaml'
1311
jobs:
1412
build:
1513
if: false

.github/workflows/ci-typescript.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@ on:
55
- main
66
paths-ignore:
77
- 'docs/**'
8-
- '.readthedocs.yaml'
98
pull_request:
109
paths-ignore:
1110
- 'docs/**'
12-
- '.readthedocs.yaml'
1311
jobs:
1412
build:
1513
if: false

.readthedocs.yaml

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/Makefile

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/_static/customize.css

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/_static/favicon.png

-233 Bytes
Binary file not shown.

docs/_static/logo.png

-13.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)