improve documentation #36
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR refocuses the documentation site from generic Docusaurus tutorials to CodeQL Wrapper–specific content by updating homepage components, streamlining sidebars, refining CLI docs, enhancing installation instructions, and removing outdated tutorial pages.
- Updated homepage header and features to highlight CodeQL Wrapper strengths
- Simplified sidebar and removed generic tutorial pages
- Enhanced installation and CLI usage guides; corrected docs structure
Reviewed Changes
Copilot reviewed 26 out of 36 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/src/pages/index.js | Simplified hero title/description props; removed tutorial button |
| docs/src/components/HomepageFeatures/index.js | Updated feature entries and conditional SVG rendering |
| docs/sidebars.js | Trimmed sidebar entries to core docs |
| docs/docusaurus.config.js | Removed favicon/logo and disabled blog nav item |
| docs/docs/intro.md | Expanded feature list in intro and reordered bullets |
| docs/docs/installation.md | Reworked install steps, added build/publish section, Docker note |
| docs/docs/cli-usage.md | Refined force-install flag description |
| Various tutorial-extras and basics MDs | Removed now-irrelevant tutorial content |
| README.md | Cleaned out old feature list and usage examples |
Comments suppressed due to low confidence (3)
docs/docs/intro.md:15
- This bullet is now duplicated (see line 13). Please remove one instance to avoid redundancy.
- **Multi-Platform CI/CD**: Works seamlessly with Jenkins, GitHub Actions, Harness, and other CI/CD tools
docs/docs/installation.md:78
- The fenced code blocks appear to be mismatched around the coverage commands. Merge the coverage lines into the bash block or add proper fences to ensure correct rendering.
**README.md:14**
* [nitpick] The README no longer includes a feature overview or basic usage. Consider adding a short summary of key features or linking to a Highlights section to keep the README self-contained.
Complete documentation is available at: https://moduscreate-perdigao-ghas-playground.github.io/codeql-wrapper/
</details>
| <Layout | ||
| title={`Hello from ${siteConfig.title}`} | ||
| description="Description will go into a meta tag in <head />"> | ||
| title={`${siteConfig.title}`} |
There was a problem hiding this comment.
The template literal around siteConfig.title is unnecessary. You can simplify to title={siteConfig.title}.
| title={`${siteConfig.title}`} | |
| title={siteConfig.title} |
Copilot uses AI. Check for mistakes.
| codeql-wrapper analyze /path/to/repo --output-dir /path/to/results | ||
|
|
||
| # Force CodeQL reinstallation | ||
| # Force CodeQL reinstallation using the latest CodeQL version before runing the analyze |
There was a problem hiding this comment.
There's a typo in "runing"—it should be "running". Also consider rephrasing to "before running the analysis" for clarity.
| # Force CodeQL reinstallation using the latest CodeQL version before runing the analyze | |
| # Force CodeQL reinstallation using the latest CodeQL version before running the analysis |
Copilot uses AI. Check for mistakes.
| label: 'Documentation', | ||
| }, | ||
| { to: '/blog', label: 'Blog', position: 'left' }, | ||
| //{ to: '/blog', label: 'Blog', position: 'left' }, |
There was a problem hiding this comment.
[nitpick] If blogging is no longer supported, consider removing this commented nav item entirely or add a note explaining why it's kept.
| //{ to: '/blog', label: 'Blog', position: 'left' }, | |
Copilot uses AI. Check for mistakes.
1 participant
No description provided.