docs: refresh the `dkit --help` example and the data files table in the README

Open Beginner friendly
  • Is something wrong?
#83 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
cli, python
Domain
cli, documentation

Research direction

Start with README.md, then run dkit --help and inspect the JSON files in src/dkit/data/, especially their _comment and source keys. Verify the listed counts on main, update the help example and data table, and search the README for other outdated command lists or example output. Done means the README matches current CLI output and data, with any other mismatches fixed or noted in the PR.

Written by the indexing model from the issue text.

Description

documentation good first issue

Two parts of README.md are out of date:

  1. The dkit --help example (section "Usage") lists 8 commands, but dkit --help prints 13 now. channels, scopes, completion, flags and scheduled-events are missing, and the help text of errors and the other entries has changed ("look up Discord HTTP and JSON error codes" and so on).
  2. The table under "Data and provenance" lists 8 files, but src/dkit/data/ contains 10. error_codes.json and user_flags.json are missing.

What to do

  • Run dkit --help and paste the real output into the example (do not retype it, the column widths change with the longest command name).
  • Add the two missing rows to the data table. Use the source and source_rendered URLs from the _comment/source keys of each JSON file, and describe the contents with the real numbers (count the entries in the file).
  • The other counts in the table (52 permissions, 21 intents, 29 scopes, 32 locales, 13 channel types, 9 timestamp styles) are correct right now. Please check that they still are on main when you start, and do not change them without checking.
  • While you are there, search the README for other statements that no longer match the CLI (command lists, example outputs) and fix or mention them in the PR.

Notes

  • Docs only: no code or data changes, no CHANGELOG entry needed.
  • Please run ruff check . and the tests anyway before you open the PR.

Please comment on this issue before you start (see CONTRIBUTING.md). AI-assisted contributions are welcome, please mention it in the PR description.

Dominant language
Python
Stars
1
Forks
7
Avg merge
11h 50m
Merged PRs (30d)
35

Getting set up

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.

More from Bytewave1/dkit

All issues in Bytewave1/dkit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.