Skip to content

docs: create dedicated wiki pages and apply repository audit fixes - #3

Merged
FunToHard merged 1 commit into
mainfrom
docs/wiki-pages-issue-2
Nov 7, 2026
Merged

FunToHard merged 1 commit into
mainfrom
docs/wiki-pages-issue-2

Conversation

@FunToHard

Copy link
Copy Markdown
Contributor

Summary

This pull request resolves #2 by introducing dedicated, standalone wiki documentation pages instead of redirecting wiki entries to section anchors in the repository README. In addition, it integrates repository audit improvements including Rust Clippy fixes, native crate version synchronization, and production bundle minification.

Key Changes

  1. Dedicated Wiki Articles (wiki/):

    • Compiler-Toolchain-Setup.md: Compiler discovery (MSVC, LLVM Clang, GCC/MinGW, Apple Clang, WSL), flag synthesis, external SDK detection (Vulkan, raylib, CUDA, Boost, SDL, vcpkg), and Visual Studio Developer Environment management.
    • Visual-Studio-Solution-Support.md: Static .sln, .slnx, and .vcxproj parsing, compilation database generation, configuration matrices, and MSBuild tasks.
    • Static-CMake-Integration.md: In-memory CMake parsing, target visibility scopes, transitive property propagation, and compile commands synthesis.
    • Debugging-Guide.md: DAP debugger architecture (c-cpp-pro-debug), backend configurations (lldb-dap, GDB DAP mode, MSVC), launch configurations, process attachment, and debug hovers.
    • Memory-Layout-Inspector.md: Struct memory layout inspection, alignment, padding hole calculations, 64-byte cache line boundaries, and member reordering optimization.
  2. Navigation & Links:

    • wiki/Home.md: Replaced README anchor links with direct relative wiki slugs and expanded the Quick Navigation table to cover all 7 documentation topics.
    • README.md: Re-indexed feature sections (1 through 12), added Static CMake Intelligence section, and linked sections directly to the wiki articles.
  3. Repository Audit Fixes:

    • Fixed all 26 Rust Clippy warnings in crates/c-cpp-pro-native.
    • Bumped crates/c-cpp-pro-native/Cargo.toml version to 0.4.2 matching package.json.
    • Added build:prod script and pointed vscode:prepublish to it, reducing packaged VSIX bundle size from 1.24 MB to 1.13 MB (JS bundle reduced by 43%).
    • Documented @aws-sdk/client-s3 external entry in esbuild.js.

Verification

  • TypeScript Typecheck: 0 errors (npm run check-types)
  • Unit & Integration Tests: 485/485 passed (npm test)
  • Rust Unit Tests: 7/7 passed (cargo test)
  • Rust Clippy: 0 warnings (cargo clippy --all-targets -- -D warnings)
  • VSIX Packaging: Clean build (npm run package)
  • Code Style: Strict zero-emoji compliance verified across all modified files.

Closes #2

Resolves issue #2 by creating standalone wiki articles for Compiler & Toolchain Setup, Visual Studio Solution Support, Static CMake Integration, Debugging Guide, and Memory Layout Inspector. Updates wiki/Home.md navigation and README.md section links. Also applies repo audit improvements: resolves Rust Clippy warnings, aligns native crate version to 0.4.2, and enables production minification in packaging.

Closes #2
@FunToHard
FunToHard merged commit 848683c into main Nov 7, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Title: Create dedicated wiki pages instead of linking wiki entries to README sections

1 participant