mirror of
https://github.com/luxfi/lamport.git
synced 2026-10-30 16:21:45 +00:00
zeekay
32b9a24ef5
Rebased docs site on the shared docs-template for easier upstream synchronization of layout and style improvements. Changes: - Use SITE_CONFIG and DOCS_CONFIG pattern from template - Add UPSTREAM.md documenting sync workflow - Remove template-specific files (README, scripts) - Keep Lamport-specific content and configuration To pull upstream changes: cp ~/work/lux/docs-template/app/docs/layout.tsx docs/app/docs/ (then re-apply DOCS_CONFIG values)
1.1 KiB
1.1 KiB
Upstream Template
This docs site is based on @luxfi/docs-template.
Pulling Upstream Changes
To pull layout/style improvements from the template:
# Add upstream remote (one-time)
cd ~/work/lux/docs-template
git remote add origin [email protected]:luxfi/docs-template.git 2>/dev/null || true
# In lamport repo, pull specific files from template
cd ~/work/lux/lamport
# Copy layout improvements
cp ~/work/lux/docs-template/app/docs/layout.tsx docs/app/docs/layout.tsx
cp ~/work/lux/docs-template/app/globals.css docs/app/globals.css
cp ~/work/lux/docs-template/components/logo.tsx docs/components/logo.tsx
# Re-apply Lamport-specific config (edit DOCS_CONFIG in layout.tsx)
Template Structure
Files from template (can be updated):
app/layout.tsx- Base layout (update SITE_CONFIG after copy)app/docs/layout.tsx- Sidebar layout (update DOCS_CONFIG after copy)app/globals.css- Stylescomponents/logo.tsx- Logo componentlib/source.ts- Content source
Files specific to Lamport (don't overwrite):
content/docs/*.md- Documentation contentcontent/docs/meta.json- Sidebar structurepublic/og.png- OG image