Repository navigation
docs(readme): move the reference material into a published docs site - #178
Merged
Merged
Conversation
The README held the only documentation, and it left out the request rules, the error responses, the upstream providers, the flags and the metrics. A docs site under docs/ now covers them, built by MkDocs and published by Read the Docs. The README keeps a description, a quick start and a table of pages. - docs/ gains installation, configuration, API, architecture and metrics pages. - .readthedocs.yaml installs the MkDocs packages with double-quoted pins, and mkdocs.yml builds in strict mode. - CONTRIBUTING.md points at docs/ and drops a workflow that does not exist. - README links are absolute, because the chart release packages it. - Strict mode builds the site cleanly, and its anchors, diagram and external links all resolve.
Not up to standards ⛔🔴 Issues
|
| Category | Results |
|---|---|
| CodeStyle | 1 minor |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
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
The documentation moves into a MkDocs site under
docs/for Read the Docs to publish, with pages for installation, configuration, the API, the architecture and metrics. The README keeps a description, a Helm quick start and a table of pages.Related Issues
Fixes #175.
Changes Made
User-Agent, which the Nominatim usage policy does not accept. The architecture page links both providers' terms.Testing
mkdocs build --strictwith the pinned packages on Python 3.14 - buildsmmdcon the architecture diagram - rendersChecklist
CONTRIBUTING.mdpoints interface changes atdocs/