docs: update & fixes#473
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request enhances the documentation site by adding SEO-friendly descriptions to the frontmatter of numerous Markdown files and implementing JSON-LD structured data for documentation pages. It also introduces new SVG-based diagram components and sets up several 301 redirects for legacy paths. Feedback is provided regarding the new InsideCollector.vue component, which contains a significant amount of commented-out code and dead logic that should be cleaned up to improve maintainability.
| let timeline = null; | ||
|
|
||
| //gsap.registerPlugin(GSDevTools); | ||
|
|
||
| onMounted(() => { | ||
| //GSDevTools.create({ animation: timeline }); | ||
| // Reset elements to initial state | ||
| // gsap.set(`.${selector_prefix}annotation`, { opacity: 1 }); | ||
| // timeline = gsap.timeline({ defaults: { ease: "back" } }); | ||
| // GSDevTools.create({ animation: timeline }); | ||
| // timeline | ||
| // .to(`#${selector_prefix}xxx`, { autoAlpha: 1, duration: 0.1 }) | ||
| // .from(`#${selector_prefix}xxx`, { | ||
| // opacity: 0, | ||
| // stagger: { | ||
| // each: 0.8, | ||
| // from: "end", | ||
| // }, | ||
| // }) | ||
| // ; | ||
| }); | ||
|
|
||
| onUnmounted(() => { | ||
| // Clean up timeline on unmount | ||
| if (timeline) { | ||
| timeline.kill(); | ||
| timeline = null; | ||
| } | ||
| }); |
There was a problem hiding this comment.
This component appears to be a work-in-progress for an animated diagram, but contains a significant amount of commented-out and non-functional code.
- The
timelinevariable is initialized tonulland never reassigned, which makes the cleanup logic inonUnmounteddead code. - The
onMountedhook is filled with commented-out animation logic.
To improve maintainability, please remove the unused code. If animations are planned for the future, consider adding a // TODO comment with details about the intended implementation or moving the logic to a separate composable function.
1. .vitepress/config.mts — added TechArticle JSON-LD schema to all docs pages (except getting-started.md which already has HowTo)
2. 53 markdown files — added targeted description frontmatter to every docs page lacking one, covering:
- 2 core docs (architecture.md, cdevents.md)
- 17 collector core pages
- 8 source extractors
- 10 parsers
- 9 sinks
- 2 database pages
- 6 Grafana dashboard pages
1. assets/_redirects — added 7 rules:
- /blog/*.html → /blog/:splat (301) — catches all .html blog URLs Google indexed
- /docs/vs-*.html → /docs/alternatives/vs-* (301) — .html variants of existing doc redirects
2. .vitepress/config.mts — fixed getDraftExcludes() bug: it was calling getBlogPosts(blogDir, false) which returns published posts, then adding them to srcExclude —
silently preventing all blog posts from generating HTML pages. Fixed to filter for unpublished/draft posts only.
The Disallow: /*? stops Googlebot from crawling any URL with query params on cdviz.dev. Static doc site has no real query param pages, so no collateral damage.
1 participant
No description provided.