Commit 8eb3d97
AFDocs: Improve docs accessibility for agents (#3297)
* AFDocs: Improve docs accessibility for agents
* Fix
* TEMP: Probe RTD markdown converter element handling
Temporary markers on the product_catalog page to determine which
wrappers the RTD/Cloudflare HTML->Markdown converter strips.
Will be removed once the experiment concludes.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* TEMP: Round 2 converter probes with link-rich content
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* AFDocs: Keep sidebar nav out of agent-facing Markdown output
HTML->Markdown converters used by AI agents (e.g. the one behind
Read the Docs' 'Accept: text/markdown' content negotiation) skip
<nav>/<header>/<footer> elements, but only until the first closing
tag - nested <nav> elements make them leak most of the sidebar into
the converted Markdown (~170 lines of nav noise per page).
Restructure the sidebar so each skippable region is a single <nav>
with no nested nav/header/footer inside:
- main.html: the main_nav wrapper div becomes the one <nav> landmark
- nav.html / nav-item.html: inner md-nav elements become <div>s
- toc.html: inner group <nav>s become <div>s; the outer wrapper stays
<nav> standalone but renders as <div> when embedded in the sidebar
Styling and behavior are unchanged: all CSS targets classes and
Material's JS targets data-md-component attributes.
Also removes the temporary converter probe markup.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* AFDocs: Render llms.txt description as blockquote summary
The llms.txt spec expects the summary right after the H1 title to be
a blockquote. mkdocs-llmstxt emits markdown_description verbatim, so
prefix it with '> ' to produce the expected structure.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Update theme/main.html
Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>1 parent 432b98b commit 8eb3d97
41 files changed
Lines changed: 403 additions & 336 deletions
File tree
- docs
- administration/back_office
- back_office_elements
- browser
- api/event_reference
- content_management
- field_types
- pages
- js
- permissions
- personalization
- api_reference
- templating
- twig_function_reference
- urls_and_routes
- tutorials/page_and_form_tutorial
- hooks
- tests/python
- theme
- partials
- tools/llms_txt
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 9 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
110 | 110 | | |
111 | 111 | | |
112 | 112 | | |
113 | | - | |
114 | | - | |
115 | | - | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
116 | 116 | | |
117 | 117 | | |
118 | | - | |
119 | | - | |
120 | | - | |
121 | | - | |
122 | | - | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
123 | 123 | | |
124 | 124 | | |
125 | | - | |
| 125 | + | |
126 | 126 | | |
127 | 127 | | |
128 | 128 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
| 57 | + | |
58 | 58 | | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | | - | |
65 | | - | |
66 | | - | |
67 | | - | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | | - | |
| 75 | + | |
76 | 76 | | |
77 | | - | |
78 | | - | |
79 | | - | |
80 | | - | |
81 | | - | |
82 | | - | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
83 | 83 | | |
84 | 84 | | |
85 | 85 | | |
86 | 86 | | |
87 | 87 | | |
88 | | - | |
| 88 | + | |
89 | 89 | | |
90 | | - | |
91 | | - | |
92 | | - | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
93 | 93 | | |
94 | 94 | | |
95 | 95 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
12 | | - | |
13 | | - | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
25 | | - | |
26 | | - | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
32 | | - | |
33 | | - | |
34 | | - | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
41 | | - | |
| 40 | + | |
| 41 | + | |
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
| |||
0 commit comments