ArclineIT/docs
1
0
Fork 0
Code Issues 40 Pull Requests Actions Packages Projects Releases Wiki Activity

DOCS-1: Init document work

Browse Source
This commit is contained in:
Blake Ridgway
2026-07-28 07:20:32 -05:00
parent 8f02a3fc8e
commit 0cbcc962f7
66 changed files with 12224 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@@ -1,35 +1,58 @@
# arcline-docs
Knowledge base and migration guides for arclineit.com. Hosted at `docs.arclineit.com`.
Covers migration from major shared hosts, getting-started guides for new customers, VPS setup walkthroughs, and self-hosting/privacy content that supports the Arcline pitch.
Knowledge base, migration guides, and self-hosting tutorials for Arcline. Hosted at `docs.arclineit.com`.
## Status
Planned. Not yet started.
**Complete.** All content sections are written (33 guides total across 6 sections). The Go static site builder generates a fully functional documentation site with search, sitemap, RSS feed, and 404 pages.
## Format
## Content
Static HTML generated from Markdown (Go builder using goldmark). Uses the Arcline design system (same CSS as the main website). No JavaScript framework, no CMS.
| Area | Status | Guides |
|------|--------|--------|
| Migration guides (GoDaddy, Bluehost, SiteGround, Namecheap, HostGator, WP Engine, domain transfer) | ✅ | 7 |
| Getting started (SSH, SFTP, MySQL backup, email, DNS, SSL) | ✅ | 6 |
| WordPress (install shared/VPS, WooCommerce, caching, security) | ✅ | 5 |
| VPS setup (initial setup, Nginx+PHP+MySQL, static/Node.js/Go deployment, backups, fail2ban) | ✅ | 7 |
| Privacy & self-hosting (no-CDN, arcline-check, performance, email auth) | ✅ | 4 |
| Reference (nameservers, PHP versions, plan limits, AUP, support) | ✅ | 5 |
| Legal (DPA, MSA, SLA) | ✅ | 3 |
## Content areas
## Site Builder Features
| Area | Priority |
|---|---|
| Migration guides (GoDaddy, Bluehost, SiteGround, Namecheap, HostGator, WP Engine) | High |
| Getting started (SSH, SFTP, MySQL backup, email, DNS, SSL) | High |
| WordPress (install, WooCommerce, caching without CDN, security) | Medium |
| VPS setup (Nginx, PHP-FPM, Node.js, Go services, backups, fail2ban) | Medium |
| Privacy & self-hosting (no-CDN tips, arcline-check walkthrough, email auth) | Medium |
| Reference (nameservers, PHP versions, plan limits, AUP summary) | Low |
- **Markdown → HTML** — goldmark renderer with tables, strikethroughs, task lists
- **Arcline design system** — same CSS as the main website
- **Client-side search** — JSON index with keyboard navigation (⌘K)
- **Sitemap** — `sitemap.xml` for SEO
- **RSS feed** — `rss.xml` for content syndication
- **404 page** — custom error page with search
- **Navigation** — sidebar with active page highlighting, breadcrumbs, prev/next pagers
- **Watch mode** — `--watch` flag rebuilds on content/template changes
## Planned features
## Development
- Client-side search (pagefind or simple JSON index)
- Sitemap and RSS feed generation
- Watch mode for local development
```bash
# Build the dynamic server
make build
See [todo.md](todo.md) for the full content plan and builder task list.
# Run the dev server
make run
# Build the static site (outputs to dist/)
make build-static
# Watch mode — rebuilds on content/template changes
make build-static-watch
```
## Tech Stack
- **Language**: Go
- **Markdown**: goldmark (tables, strikethrough, task lists, auto heading IDs)
- **Templates**: Go html/template
- **Storage**: SQLite (for client/admin pages)
- **Watch mode**: fsnotify
- **Static output**: `dist/` directory (self-hostable via any web server)
## License