New docs pulgin migration#1165
Conversation
Signed-off-by: Tejaswini R <Tejaswini.R1@ibm.com>
Signed-off-by: Tejaswini R <Tejaswini.R1@ibm.com>
TejaswiniIBM
requested review from
DevonianTeuchter,
HarithaIBM,
IgorTodorovskiIBM,
MikeFultonDev,
sachintu47 and
v1gnesh
as code owners
🤖 Augment PR SummarySummary: Migrates the documentation site from Docsify to VitePress and updates the docs build pipeline accordingly. Changes:
Technical Notes: The VitePress build now relies on Vue 3 + VitePress (local search provider) and generates reference docs by converting man pages via 🤖 Was this summary useful? React with 👍 or 👎 |
![augmentcode[bot]](https://avatars.githubusercontent.com/in/1027498?s=60&v=4){kind=small}
|
|
||
| # 2. Extract only the content between <body> and </body> | ||
| # This avoids injecting full-document tags (<html>, <head>, <body>) into markdown | ||
| body_content=$(sed -n '/<body>/,/<\/body>/p' "${html}" | sed '1d;$d' | sed '/<a href="#/d' | sed '/<br>$/d' | sed '/<hr>/d') |
There was a problem hiding this comment.
cicd/on_nightly.sh:57 The sed -n '/<body>/,/<\/body>/p' extraction looks too strict: groff -Thtml often emits <body ...> with attributes, so this may fail to match and produce empty body_content (blank reference pages). Consider making the <body / </body> matching more robust so docs generation doesn’t silently drop content.
Severity: medium
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| padding-top: 20px !important; | ||
| } | ||
|
|
||
| .VPDocAsideOutline { |
There was a problem hiding this comment.
docs/.vitepress/theme/custom.css:457 The .VPDocAsideOutline { block isn’t closed before the subsequent .VPDocAsideOutline .outline-link selectors, which makes those nested selectors invalid CSS and prevents the outline highlighting rules from applying. Closing the rule after padding-top should restore the intended styles.
Severity: medium
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| } | ||
|
|
||
| .dark .VPDocFooter .edit-link .edit-link-button::after { | ||
| border-top-color: #161b22 !important; |
There was a problem hiding this comment.
docs/.vitepress/theme/custom.css:370 The tooltip arrow uses border-bottom (line ~328) to draw the triangle, but the dark-mode override sets border-top-color, so the arrow color likely won’t change in dark mode. This looks like it should override the border-bottom-color instead.
Severity: low
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
3 participants
What type of PR is this? (check all applicable)
Category
Description
New docs pulgin migration to Vitepress
Related Issues
[optional] Are there any post-deployment tasks or follow-up actions required?