nuts-foundation / nuts-foundation/nuts-node

Improving documentation

Open
#4,143 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
28
Forks
23
Avg merge
1d 10h
Merged PRs (30d)
76

Description

Documentation is scattered

We have:

Latest documentation is missing v5/gRPC network documentation

Basic usage flows not documented

The most basic usage flows (request & use access token, introspect access token) are not documented.
Although there's documentation on the wiki: https://wiki.nuts.nl/books/implementing-a-nuts-use-case/page/requesting-access-outbound

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Nuts node documentation on Read the Docs, the wiki manuals, the GitBook specifications and bolts, and the linked access-token usage page. Map the missing v5/gRPC network documentation and basic request, use, and introspection flows; done means these materials have a clear documented home without scattering essential guidance across external spaces.

Written by the indexing model from the issue text.

Assessment

Tech stack
grpc
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.