docs: clarify README onboarding and auto-sync the Docker Hub description#882
Draft
ofermend wants to merge 1 commit into
Draft
docs: clarify README onboarding and auto-sync the Docker Hub description#882ofermend wants to merge 1 commit into
ofermend wants to merge 1 commit into
Conversation
- Rewrite the intro to describe concretely what Publisher does (REST + MCP: discover metadata, compile and execute queries). - Add a Concepts section (Malloy, semantic model, environment, package, connection, MCP) so terms are defined before first use. - Add a table of contents, npm/Docker/license badges, a screenshot, and a Contributing section linking CONTRIBUTING.md and LICENSE. - Expand "bring your own config" into a config-file walkthrough with a generic Postgres connection example (not BigQuery-specific) and a link to docs/connections.md. - Replace the thin Agent MCP section with a fuller "AI agents (MCP and skills)" section: core (:4040) and agent (:4041) servers, the tool list, a client config snippet, and how developers use the bundled skills. - Wire CI to keep the Docker Hub overview in sync (peter-evans/dockerhub- description) and fix repo-relative links in README.docker.md so they resolve on the Docker Hub page. Signed-off-by: Ofer Mendelevitch <[email protected]>
ofermend
marked this pull request as draft
July 11, 2026 22:14
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
A lighter-touch pass over the README to smooth first-time developer onboarding (keeping the existing structure), plus wiring CI to keep the Docker Hub overview from drifting. Prompted by an onboarding review of the repo and the public docs.
README
Malloy, semantic model, environment, package, connection, and MCP are defined before first use.CONTRIBUTING.mdandLICENSE.publisher.config.jsonschema (environments→packages→connections) and a generic Postgres connection example (nothing BigQuery-specific), with a link todocs/connections.md.:4040) tool list, the agent (:4041) server, a client-config snippet, and how a developer actually uses the bundled skills (native files vs MCP prompts).Docker Hub
docker-image.yml) gains apeter-evans/dockerhub-descriptionstep so the Docker Hub overview is kept in sync frompackages/server/README.docker.mdon every stable release — it currently drifts because nothing syncs it.README.docker.mdso they resolve on the Docker Hub page (they 404 there today).Notes
🤖 Generated with Claude Code