Website build and SGK integration
The SDK includes a static developer site and a proposed replacement EpicTuner landing page. They share SGK Embedded's dark surface and red accent. The product page links to practical onboarding and the SDK reference.
Generate and preview
python -m pip install -r tools/requirements.txt
python tools/build-docs.py --output site
python -m http.server 8080 --bind 127.0.0.1 --directory site
Open http://127.0.0.1:8080/epictuner/ and
http://127.0.0.1:8080/epictuner/sdk/. Search works locally without a backend
or network request. Code blocks have copy buttons; articles include page anchors,
source links, keyboard focus styling and responsive navigation.
Every page also links to EpicTuner-SDK-Manual.md: one generated UTF-8 file
containing all guide chapters, public C/C++ headers, schemas and complete starter
and cascading example sources. Authors can download it and give it to their
coding agent. A .md.sha256 sidecar identifies the exact generated manual.
The generator verifies local links, anchors and images and fails on a broken link or a reference outside the public SDK. To recheck existing output:
python tools/build-docs.py --output site --check
Deployable structure
site/epictuner/index.html Product landing page
site/epictuner/downloads/index.html Packages, requirements and release status
site/epictuner/assets/ Shared styling, scripts and screenshots
site/epictuner/sdk/index.html SDK home
site/epictuner/sdk/docs/ Guides and API contracts
site/epictuner/sdk/examples/ Example guides, source and synthetic fixtures
site/epictuner/sdk/include/ Public C/C++ headers
The generated files can be served from a static route under
www.sgkembedded.com/epictuner/. All internal links are relative, so a staging
subdirectory works too. If the existing site framework owns /epictuner, port
website/landing.html into that route and serve the SDK output under
/epictuner/sdk/. Preserve path casing or redirect old links consistently.
No changes to the live SGK website are made by this generator. The landing page
links to a downloads page with package descriptions, provisional requirements
and disabled Coming soon buttons. Add artifact URLs, versions, sizes, SHA-256
checksums and release notes when an approved release is available. The proprietary SDK terms permit plugin development and distribution, but prohibit
redistributing the SDK itself; see ../REDISTRIBUTION.md.
Edit the content
Edit Markdown under docs and example READMEs. The generator uses those same
sources in the SDK archive and the website. Edit website/page.html for the
documentation shell, website/landing.html for product copy,
website/downloads.html for packages and requirements, and
website/assets/site.css for the shared design.
Product screenshots are real SDK example captures using synthetic data. Replace them with fresh approved captures when the UI changes. The page avoids the old landing page's public-GitHub claim: repository publication and production release hosting are separate decisions.