docs: expand README (purpose, personas, use cases, API surface, setup)#2
Open
damienriehl wants to merge 1 commit into
Open
docs: expand README (purpose, personas, use cases, API surface, setup)#2damienriehl wants to merge 1 commit into
damienriehl wants to merge 1 commit into
Conversation
…nd setup Grow the thin README into a full one grounded in the codebase: what OntoKit API is (collaborative, Git-versioned OWL ontology curation backend), who it serves, concrete use cases, an API-surface table drawn from the registered FastAPI routers/tags, the verified tech stack, and Full-Docker/hybrid getting- started plus configuration and dev commands. README.md only — no code or license changes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018tXdDQDuzJSyebGytVvjRR
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.
Expands the thin README into a full overview per the portfolio standard: Purpose, Personas, Use cases, API surface, Tech stack, Getting started (Docker + hybrid), Configuration, Development. Every endpoint area/capability is verified against
ontokit/main.pyopenapi_tags andapi/routes/(23 modules); tech stack from pyproject/.env.example. Pre-existing badges + MIT (per pyproject) preserved; no code or LICENSE changes. Docs-only.🤖 Generated with Claude Code