Repository navigation
Bring docs and repo files up to the laranail standard - #51
Merged
Merged
Conversation
Adds the five root files the org conventions require and were missing: CHANGELOG.md, CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, .editorconfig. README: the four badges (registry, tests, static analysis, MIT), an install section that actually works -- the old one said 'composer require' with no repositories block, which fails, since laranail/* resolves through git rather than Packagist -- a Documentation section grouped into Guides / Reference / Recipes / Project, and a sister-packages table naming the whole family. docs/: adds the concern pages the standard requires and this package lacked, and gives every page the '[<- Docs index]' footer. CONTRIBUTING spells out the public-name rules and why the separators differ between registries: commands use :: because Symfony resolves an exact name before splitting on ':', middleware aliases must not because Laravel splits on ':' to take parameters, Blade prefixes must not because the tag already spends '::'. Those are forced by each registry's parser, not stylistic, so they are written down rather than left to be rediscovered.
There was a problem hiding this comment.
Pull request overview
Adds missing repository-standard documentation and reorganizes the existing docs/README to match the org “laranail standard” (policies + structured docs index + installation guidance), without changing runtime source code.
Changes:
- Add repo root standard files:
CHANGELOG.md,CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md,.editorconfig. - Update
README.mdwith badges, corrected installation guidance (including required Composerrepositoriesblock), structured Documentation section, and sister-packages table. - Add/extend docs pages (installation/getting-started/architecture/release) and add a consistent “[← Docs index]” footer across docs pages.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
SECURITY.md |
Adds a security policy and reporting process. |
README.md |
Adds badges, correct install instructions, structured docs index, and sister-package overview. |
docs/testing.md |
Adds docs-index footer navigation. |
docs/social-login.md |
Adds docs-index footer navigation. |
docs/security.md |
Adds docs-index footer navigation. |
docs/release.md |
Adds new release/versioning guidance page plus docs-index footer. |
docs/registration.md |
Adds docs-index footer navigation. |
docs/profile-management.md |
Adds docs-index footer navigation. |
docs/password-updates.md |
Adds docs-index footer navigation. |
docs/password-reset.md |
Adds docs-index footer navigation. |
docs/passkeys.md |
Adds docs-index footer navigation. |
docs/login.md |
Adds docs-index footer navigation. |
docs/installation.md |
Adds new installation walkthrough plus docs-index footer. |
docs/getting-started.md |
Adds new “getting started” guide plus docs-index footer. |
docs/email-verification.md |
Adds docs-index footer navigation. |
docs/configuration.md |
Adds docs-index footer navigation. |
docs/architecture.md |
Adds new architecture overview plus docs-index footer. |
docs/api-tokens.md |
Adds docs-index footer navigation. |
CONTRIBUTING.md |
Adds contribution workflow + naming rules rationale. |
CODE_OF_CONDUCT.md |
Adds code-of-conduct policy pointer. |
CHANGELOG.md |
Adds changelog scaffold following Keep a Changelog. |
.editorconfig |
Adds editor defaults for consistent formatting. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+3
to
+6
| [](https://packagist.org/packages/laranail/authkit) | ||
| [](https://github.com/laranail/authkit/actions/workflows/tests.yml) | ||
| [](https://github.com/laranail/authkit/actions/workflows/static.yml) | ||
| [](LICENSE) |
| - [Testing](docs/testing.md) | ||
| ### Reference | ||
|
|
||
| - [Login](docs/login.md) · [Registration](docs/registration.md) · [Logout](docs/logout.md) |
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
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.
Fills the gaps against the org docs standard. Existing prose is left alone — this adds what was missing.
Root files — all five were absent:
CHANGELOG.md,CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md,.editorconfig.README — the four required badges; a
Documentationsection grouped into Guides / Reference / Recipes / Project; a sister-packages table naming the whole family.The install section was wrong, not just thin: it said
composer require laranail/authkitwith no repositories block, which fails outright, sincelaranail/*resolves through git rather than Packagist. Now shows the block and links the full walkthrough.docs/ — adds the concern pages the standard requires and this package lacked, and gives every page the
[← Docs index]footer.CONTRIBUTING.mdwrites down why the separators differ between registries — commands use::because Symfony resolves an exact name before splitting on:; middleware aliases must not, because Laravel doesexplode(':', $name, 2)to take parameters; Blade prefixes must not, because the tag already spends::. Those are forced by each registry's parser, so they're recorded rather than left to be rediscovered.Docs only — no source changes. Suite unchanged and green.
🤖 Opened by Claude Code