docs: add enterprise README with architecture, API reference, and badges#1
Closed
docs: add enterprise README with architecture, API reference, and badges#1
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
README.mdto replace the missing project documentationDetails
This is the first step in the enterprise GitHub governance upgrade. The README includes:
Next Steps
Follow-up PRs will add remaining enterprise governance files:
LICENSE,SECURITY.md,CONTRIBUTING.md,CODE_OF_CONDUCT.mdCODEOWNERS,.editorconfig,.nvmrc,CHANGELOG.md.github/ISSUE_TEMPLATE/,.github/PULL_REQUEST_TEMPLATE.md,.github/dependabot.ymlNote
Low Risk
Documentation-only change; no code, runtime, or security behavior is modified.
Overview
Adds a new top-level
README.md(previously missing) to provide enterprise-style project documentation.The README introduces badges (CI/license/runtime/test status), an overview of key capabilities, an ASCII architecture diagram, quick-start commands (dev/test/build/Docker), a project structure tree, an API reference table of endpoints, and links to
SECURITY.md,CONTRIBUTING.md, andLICENSEwith BSL 1.1 change-date notes.Written by Cursor Bugbot for commit e68cc0d. This will update automatically on new commits. Configure here.