Skip to content

docs: move Discovery Service design and API usage to the wiki - #4676

Open
reinkrul wants to merge 4 commits into
docs/rtd-move-jsonldfrom
docs/rtd-move-discovery
Open

reinkrul wants to merge 4 commits into
docs/rtd-move-jsonldfrom
docs/rtd-move-discovery

Conversation

@reinkrul

@reinkrul reinkrul commented Nov 5, 2026 •

Copy link
Copy Markdown
Member

Part of the Read the Docs → wiki move (stacked on #4675).

deployment/discovery.rst keeps only what the operator needs:

  • short intro, with links to the wiki pages Service Discovery (designing), Register on the Discovery Service and Find care organizations and their endpoints (implementing)
  • loading service definitions from discovery.definitions.directory, the service definition example and a full description of its fields (required/optional, how the node uses each one, how it uses the presentation definition), and the 64 KiB registration limit
  • "Servers" section unchanged
  • the RFC022 link moved to the top: "This implements Nuts RFC022 Discovery Service"

Removed: the Clients and Registration sections (API usage). The wiki already covered them; the "only text fields are searchable" rule was added there. The API rules are in the Discovery OpenAPI spec.

integrating/version-incompatibilities.rst linked the removed "Registration" section; it now links the wiki page.

Assisted by AI

@reinkrul
reinkrul force-pushed the docs/rtd-move-discovery branch from 2c6bab5 to cce8d5f Compare November 6, 2026 15:57

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants