Migrate docs to VitePress#167
Merged
Merged
Conversation
- Reorganize docs/ into guide/, authentication/, authorization/ with kebab-case file names - Split the README's mixed concerns (overview, install, troubleshooting, upgrade) into dedicated guide pages - Add new 5-min quick-start with the smallest working two-INI-file setup - Add VitePress config with sidebar groups, top nav, local search, sitemap, lastUpdated, brand-colored theme, and SVG padlock logo - Add GitHub Pages deploy workflow building from docs/ on push to master - Move CONTRIBUTING.md to repo root for GitHub auto-link - Add docs URL to composer.json support metadata - Update root README.md to point to https://dereuromark.github.io/cakephp-tinyauth/
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #167 +/- ##
=========================================
Coverage 67.59% 67.59%
Complexity 627 627
=========================================
Files 29 29
Lines 1614 1614
=========================================
Hits 1091 1091
Misses 523 523 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…eware/policy, CLI commands Audit of src/ vs docs/ surfaced public-facing functionality the original prose never described: - New authentication/impersonation.md — PrimaryKeySessionAuthenticator with the impersonate() flow, full config table, start/detect/stop pattern - New guide/custom-adapters.md — interfaces, return shapes for both Allow and ACL adapters, registration via TinyAuth.allowAdapter / aclAdapter, skeleton DB-driven example - New authorization/middleware.md — RequestAuthorizationMiddleware config table, RequestPolicy reference, both unauthorized handlers (ForbiddenRedirect, ForbiddenCakeRedirect) with full options - New reference/cli.md — tiny_auth add and tiny_auth sync with all arguments, options, interactive mode, and a typical project workflow Sidebar updated to surface the four new pages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates the docs from a flat camel-case layout (
docs/Authentication.md,docs/AuthUser.md, etc.) to a structured VitePress site at https://dereuromark.github.io/cakephp-tinyauth/.Structure
15 pages total. All files renamed to kebab-case under topic folders. Internal cross-links rewritten to absolute VitePress paths. The 4 image references in
auth-panelupdated to root-relative paths after movingimg/todocs/public/img/. Local search, sitemap, lastUpdated timestamps, brand-colored theme, and a custom SVG padlock logo + favicon shipped underdocs/public/.Files of note
docs/.vitepress/config.ts— sidebar groups, top nav, search, sitemap, lastUpdated, editLinkdocs/.vitepress/theme/custom.css— brand colors and hero glow.github/workflows/deploy-docs.yml— builds and publishes to GitHub Pages on push to master (paths-filter ondocs/**)CONTRIBUTING.md— moved from the README's contributing section to repo root for GitHub auto-linkcomposer.json— addedsupport.docsURLREADME.md— points users at the deployed docs URLManual step required after merge
GitHub repo Settings → Pages → Source = "GitHub Actions" (one-time toggle so the deploy workflow can publish).
Heads-up
External bookmarks to the old camel-case
docs/Authentication.md,docs/Authorization.md, etc. will 404 after merge — intentional restructure cost. Worth a one-line note in the next release.