Skip to content

Add GitHub Pages documentation site - #7

Merged
theworker02 merged 1 commit into
mainfrom
cursor/github-pages-site
Aug 3, 2026
Merged

Add GitHub Pages documentation site#7
theworker02 merged 1 commit into
mainfrom
cursor/github-pages-site

Conversation

@theworker02

Copy link
Copy Markdown
Owner

Summary

  • Wire MkDocs Material on the existing docs/site/ tree with ShiftLock brand colors, logo, and grouped nav
  • Add .github/workflows/pages.yml to build and deploy via official Pages actions (push to main + workflow_dispatch)
  • Flesh home / intro / quick-start, keep site deps in requirements-docs.txt (out of go.mod), and document the expected Pages URL in the README

Test plan

  • Confirm mkdocs build --strict -f docs/site/mkdocs.yml succeeds (verified locally)
  • In repo Settings → Pages, set source to GitHub Actions if not already
  • After merge (or via workflow_dispatch on main), confirm deploy job succeeds
  • Visit https://theworker02.github.io/shiftlock/ and check home, quick start, search, and theme
  • Confirm CI still passes and go.mod has no docs/Python deps

Made with Cursor

Publish docs/site via Actions so ShiftLock has a branded static docs URL without pulling site deps into go.mod.

Co-authored-by: Cursor <cursoragent@cursor.com>
@theworker02
theworker02 merged commit d9b5bde into main Aug 3, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant