WIP

Author: GordonSmith

.github/workflows/deploy-docs.yml

@@ -4,7 +4,6 @@ on:
     push:
         branches:
             - main
-            - DOCS
     workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages

.gitignore

@@ -1,4 +1,5 @@
 /.vitepress/cache
+/.vitepress/dist
 /.vscode/settings.json
 /build
 /node_modules

README.md

@@ -1,6 +1,16 @@
+[![MacOS](https://github.com/GordonSmith/component-model-cpp/actions/workflows/macos.yml/badge.svg)](https://github.com/GordonSmith/component-model-cpp/actions/workflows/macos.yml)
+[![Windows](https://github.com/GordonSmith/component-model-cpp/actions/workflows/windows.yml/badge.svg)](https://github.com/GordonSmith/component-model-cpp/actions/workflows/windows.yml)
+[![Ubuntu](https://github.com/GordonSmith/component-model-cpp/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/GordonSmith/component-model-cpp/actions/workflows/ubuntu.yml)
+[![codecov](https://codecov.io/gh/GordonSmith/component-model-cpp/graph/badge.svg?token=CORP310T92)](https://codecov.io/gh/GordonSmith/component-model-cpp)
+
+<p align="center">
+  <img src="https://github.com/WebAssembly/WASI/blob/main/WASI.png?raw=true" height="160" width="auto" />
+  <img src="https://repository-images.githubusercontent.com/254842585/4dfa7580-7ffb-11ea-99d0-46b8fe2f4170" height="160" width="auto" />
+</p>
+
 # Component Model C++ (Developer Reference)
 
-This repository provides a header-only C++20 implementation of the WebAssembly Component Model canonical ABI. The code mirrors the official [Python Reference](`ref/component-model/design/mvp/canonical-abi/definitions.py`) and the [Specification](`ref/component-model/design/mvp/CanonicalABI.md`). All behavior (naming, state transitions, error conditions) should remain aligned with the reference.
+This repository provides a header-only C++20 implementation of the WebAssembly Component Model canonical ABI. The code mirrors the official [Python Reference](https://github.com/GordonSmith/component-model-cpp/blob/main/ref/component-model/design/mvp/canonical-abi/definitions.py) and the [Specification](https://github.com/GordonSmith/component-model-cpp/blob/main/ref/component-model/design/mvp/CanonicalABI.md). All behavior (naming, state transitions, error conditions) should remain aligned with the reference.
 
 ## Official Documentation, Issues, and Discussions
 

samples/README.md

@@ -60,7 +60,7 @@ cd build/samples/wamr
 ./wamr
 ```
 
-See [`wamr/README.md`](wamr/README.md) for detailed documentation, including:
+See [Generated WAMR Helpers](../docs/generated-wamr-helpers.md) for detailed documentation, including:
 - Complete API reference
 - Type system examples
 - Building and running instructions
@@ -313,7 +313,7 @@ To add a new sample:
 6. Add comprehensive README with usage instructions
 7. Add tests demonstrating key functionality
 
-See [`CONTRIBUTING.md`](../CONTRIBUTING.md) (if exists) for general contribution guidelines.
+Contribution guidelines will be published alongside the main repository documentation.
 
 ## References
 
@@ -324,4 +324,4 @@ See [`CONTRIBUTING.md`](../CONTRIBUTING.md) (if exists) for general contribution
 
 ## License
 
-See [LICENSE](../LICENSE) in the root directory.
+See the project [LICENSE](https://github.com/GordonSmith/component-model-cpp/blob/main/LICENSE) in the root directory.

test/README.md

@@ -27,7 +27,7 @@ cd build && ctest -R component-model-test
 
 Validates the ANTLR4-based WIT parser against official test files from the [wit-bindgen](https://github.com/bytecodealliance/wit-bindgen) project.
 
-**📖 See [TESTING_GRAMMAR.md](TESTING_GRAMMAR.md) for complete grammar testing documentation.**
+**📖 Detailed grammar testing instructions are included in this section.**
 
 #### Requirements
 - Java Runtime Environment (for ANTLR)
@@ -63,8 +63,7 @@ cd build && ctest -C Release -R wit-grammar-test --verbose
 
 Generate C++ host function stubs from all WIT test files. Useful for testing the code generator and creating reference implementations.
 
-**📖 See [STUB_GENERATION.md](STUB_GENERATION.md) for stub generation scripts.**  
-**📖 See [CODEGEN_VALIDATION.md](CODEGEN_VALIDATION.md) for the validation framework.**
+**📖 Stub generation and validation guidance appears throughout this section.**
 
 #### Quick Start
 
@@ -142,7 +141,7 @@ The framework also validates generated code by attempting to compile it:
 cmake --build build --target test-stubs-full
 ```
 
-**⚠️ IMPORTANT**: Compilation failures are **expected and useful**! They indicate bugs in `wit-codegen` that need fixing. See [CODEGEN_VALIDATION.md](CODEGEN_VALIDATION.md) for details on interpreting failures.
+**⚠️ IMPORTANT**: Compilation failures are **expected and useful**! They indicate bugs in `wit-codegen` that need fixing. Detailed validation notes are included in the following section.
 
 #### Generated Files
 
@@ -478,6 +477,6 @@ Grammar tests automatically pick up all `.wit` files in the test directory. To t
 ## Related Documentation
 
 - [Main README](../README.md) - Project overview
-- [Grammar README](../grammar/README.md) - Grammar documentation
-- [Component Model Specification](../ref/component-model/design/mvp/CanonicalABI.md)
-- [WIT Specification](../ref/component-model/design/mvp/WIT.md)
+- [Grammar README](https://github.com/GordonSmith/component-model-cpp/blob/main/grammar/README.md) - Grammar documentation
+- [Component Model Specification](https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md)
+- [WIT Specification](https://github.com/WebAssembly/component-model/blob/main/design/mvp/WIT.md)