Commit 1b4eee0
authored
[DOCS] Apply selected README and documentation fixes (#36535)
PR body:
### Details:
- Apply selected small documentation fixes from external documentation
PRs:
- PR #34505: fix malformed Markdown code fences and a duplicated
blockquote marker in `docs/documentation_build_instructions.md`.
- PR #34551: fix two broken README documentation links:
- Integrations link
- GenAI detailed guide link
- PR #35009: add spacing between the OpenVINO Notebooks link and the
book emoji in `README.md`.
- PR #34981: add a simple README installation verification step, with
the Markdown fixed locally.
- Preserve the generic `<openvino_repository_url>` placeholder from
`docs/documentation_build_instructions.md` instead of applying PR
#34505's hard-coded upstream clone URL, because the placeholder is more
appropriate for forks, mirrors, and internal checkouts.
- Use PR #34551's direct OpenVINO Integrations page instead of duplicate
PR #35083's broader ecosystem page.
- Use PR #35009 as the applied source for the README spacing fix; PR
#35008 contains the same patch.
- Fix PR #34981's missing Python code fence before applying the
verification snippet.
### Validation:
- Ran Sphinx documentation build successfully after the
`docs/documentation_build_instructions.md` fix:
- `cmake --build build --target sphinx_docs -j2`
- Build completed with existing warnings.
- Verified replacement README documentation URLs return HTTP 200.
- Ran `git diff --check -- README.md`.
- Validated the README verification snippet syntax.
- Confirmed `openvino.__version__` is used in existing OpenVINO
sources/docs.
### Tickets:
- N/A
- Related PRs: #34505, #34551, #35009, #34981
- Related duplicate PRs: #35083, #35008
### AI Assistance:
- AI assistance used: yes
- AI was used to inspect the existing backlog PRs, compare duplicate
patches, prepare local edits, and summarize validation results.
- Human validation included reviewing the selected changes, confirming
which original PR changes to preserve or omit, running local
checks/builds, and deciding which PRs should be handled manually.1 parent ade5947 commit 1b4eee0
2 files changed
Lines changed: 15 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| |||
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
38 | 47 | | |
39 | 48 | | |
40 | 49 | | |
41 | 50 | | |
42 | 51 | | |
43 | 52 | | |
44 | | - | |
| 53 | + | |
45 | 54 | | |
46 | 55 | | |
47 | 56 | | |
| |||
100 | 109 | | |
101 | 110 | | |
102 | 111 | | |
103 | | - | |
| 112 | + | |
104 | 113 | | |
105 | 114 | | |
106 | 115 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
| 30 | + | |
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| |||
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
51 | | - | |
| 51 | + | |
52 | 52 | | |
0 commit comments