docs: rewrite README to reflect the actual API#66
Merged
Conversation
The previous README was a generic template ("art_platform", wrong clone
URL, wrong Dockerfile path, no real configuration or auth docs). Rewrite
it to describe the real service: .NET 8 / EF Core / PostgreSQL, Auth0
scope-based auth, Stripe Connect, Novu, the repo layout, the API surface,
full configuration reference, local setup with Docker Postgres, migrations,
Docker, and the CI/CD pipeline.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
What
Replaces the generic template README with accurate documentation of the real service.
Why
The old README described a different/aspirational project — it referenced
art_platform, a wrong clone URL (D4M13N-D3V/art_platform), a non-existent Dockerfile path (./src/ArtPlatform.API/Dockerfile), port 80, and had empty "describe your API here" placeholders. None of it matched the codebase.New README covers
dotnet run(port 5290, swagger path)All facts verified against the running app and source this session.