ServiceForge Documentation is the public docs site for the ServiceForge platform. It is a statically exported Next.js app that renders Markdown content from the content/guide folder and is deployed to GitHub Pages.
Live site: https://softlaneit.github.io/serviceforge-io/
Source repository: https://github.com/SoftLaneIT/serviceforge.git
The site is organized around the core ServiceForge product flows:
- Introduction to the platform and its service map
- Quick start walkthrough for standing up the stack locally
- API reference for the management, booking, and config services
- Configuration module documentation for tenant-scoped behavior
- Booking policy rules and enforcement order
- TypeScript integration examples for consumers
- Developer guide for local development and contribution patterns
- Self-hosting and on-prem deployment notes
- Next.js 16 App Router
- TypeScript
- Markdown content authored in
content/guide/*.md gray-matter,remark,remark-gfm, andremark-htmlfor content parsing- GitHub Actions for build and GitHub Pages deployment
npm installnpm run devOpen http://localhost:3000 to view the site.
npm run buildThe production build exports the site to out/ so it can be hosted on GitHub Pages.
npm run lintDocumentation pages live in content/guide/ and are rendered from Markdown files.
| File | Purpose |
|---|---|
introduction.md |
Platform overview and architecture |
quick-start.md |
Local setup and first booking walkthrough |
api-reference.md |
REST endpoint documentation |
config-modules.md |
Full module field reference |
booking-policy.md |
Booking validation and enforcement rules |
typescript-integration.md |
Client integration examples |
developer-guide.md |
Development and contribution notes |
on-prem.md |
Self-hosting and deployment guidance |
/redirects to/introduction/[slug]renders the matching Markdown file fromcontent/guide- Navigation is generated from the Markdown front matter and ordering metadata
This repository is configured for GitHub Pages with a static export.
next.config.tsenablesoutput: "export"and the project base path..github/workflows/deploy.ymlbuilds on every push tomain.public/.nojekyllprevents GitHub Pages from stripping Next.js assets.
If you want to redeploy manually, push to main and GitHub Actions will publish the updated out/ directory automatically.
content/guide/ Markdown docs that power the site
public/ Static assets and GitHub Pages marker files
src/app/ Next.js App Router pages and shared layout
src/lib/ Markdown and content loading helpers
.github/workflows GitHub Pages deployment workflow
Keep changes focused on the documentation experience and content structure. When adding a new guide page, update the front matter so it appears in the sidebar in the correct order.