Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/publish-wiki.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Publish Wiki

on:
push:
branches: [main]
paths:
- 'docs/**'
- 'README.md'

jobs:
publish-wiki:
name: Publish Wiki
runs-on: ubuntu-latest

permissions:
contents: write

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Publish wiki
uses: Andrew-Chen-Wang/github-wiki-action@v4
env:
WIKI_DIR: docs/
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_MAIL: github-actions[bot]@users.noreply.github.com
GH_NAME: github-actions[bot]
26 changes: 26 additions & 0 deletions docs/Home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Struct Frame Wiki

Welcome to the Struct Frame documentation wiki.

Struct Frame is a cross-platform code generation framework that converts Protocol Buffer (.proto) files into serialization/deserialization code for C, C++, TypeScript, Python, and GraphQL.

## Documentation

- [[What is Struct Frame|index]] - Introduction and overview
- [[Installation and Usage|installation]] - Getting started guide
- [[Message Definitions|message-definitions]] - Proto file syntax reference
- [[Framing|framing]] - Frame formats and parsing
- [[Testing|testing]] - Test suite documentation
- [[Development Guide|development]] - Contributing and extending

## Quick Links

- [GitHub Repository](https://github.com/mylonics/struct-frame)
- [README](https://github.com/mylonics/struct-frame#readme)

## Feature Highlights

- **Multi-Language Support**: C, C++, TypeScript, Python, GraphQL
- **Zero-Copy in C/C++**: Direct memory mapping without encoding overhead
- **Small Frame Overhead**: Only 4 bytes for basic framing
- **No Runtime Dependencies**: Header-only C/C++ implementation
14 changes: 14 additions & 0 deletions docs/_Sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Navigation

- [[Home]]
- [[What is Struct Frame|index]]
- [[Installation|installation]]
- [[Message Definitions|message-definitions]]
- [[Framing|framing]]
- [[Testing|testing]]
- [[Development|development]]

## Links

- [Repository](https://github.com/mylonics/struct-frame)
- [Issues](https://github.com/mylonics/struct-frame/issues)