docs: document auth command, private drivers #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

amoeba wants to merge 33 commits into main from docs/auth-registries-ci

Member

amoeba commented Jan 21, 2026 •

edited

Loading

Adds a new guide for private drivers
Minimally links in notes about private drivers in other pages.
Adds a "since_version" badge using mkdocs-macros so we can mark things as being only available in certain releases.

Closes #252

amoeba added 6 commits

January 20, 2026 19:57


          Update .gitignore

22ad697


          Add since-version badge

ed32b51


          add auth command to cli docs

87a5e41


          add note in finding drivers about auth

e64072f


          add private drivers guide

41a0c4a


          fix typo in macros.py docstring and broken link in finding_drivers.md

4ee0705

amoeba temporarily deployed to snapshot

January 21, 2026 04:39

— with

GitHub Actions Inactive

ianmcook reviewed

View reviewed changes

docs/guides/private_drivers.md Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/guides/private_drivers.md Outdated Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/guides/private_drivers.md Outdated Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/guides/private_drivers.md Outdated Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/guides/private_drivers.md Outdated Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/guides/private_drivers.md Outdated Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/guides/private_drivers.md Outdated Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/guides/finding_drivers.md Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/guides/finding_drivers.md Outdated Show resolved Hide resolved


          Update docs/guides/private_drivers.md

756fa96

Co-authored-by: Ian Cook <ianmcook@gmail.com>

amoeba temporarily deployed to snapshot

January 21, 2026 18:02

— with

GitHub Actions Inactive

amoeba and others added 2 commits

January 21, 2026 10:02


          Update docs/guides/private_drivers.md

090898f

Co-authored-by: Ian Cook <ianmcook@gmail.com>


          Update docs/guides/private_drivers.md

3ede3e9

Co-authored-by: Ian Cook <ianmcook@gmail.com>

amoeba temporarily deployed to snapshot

January 21, 2026 18:03

— with

GitHub Actions Inactive


          Update docs/guides/private_drivers.md

0107cd4

Co-authored-by: Ian Cook <ianmcook@gmail.com>

amoeba temporarily deployed to snapshot

January 21, 2026 18:03

— with

GitHub Actions Inactive

amoeba and others added 2 commits

January 21, 2026 10:14


          Update docs/guides/private_drivers.md

4655d4b

Co-authored-by: Ian Cook <ianmcook@gmail.com>


          Update docs/guides/finding_drivers.md

8bdbba9

Co-authored-by: Ian Cook <ianmcook@gmail.com>

amoeba temporarily deployed to snapshot

January 21, 2026 18:15

— with

GitHub Actions Inactive

zeroshade reviewed

View reviewed changes

docs/guides/private_drivers.md Outdated Show resolved Hide resolved

zeroshade reviewed

View reviewed changes

docs/reference/cli.md Show resolved Hide resolved


          Update docs/guides/private_drivers.md

c8846ca

Co-authored-by: Ian Cook <ianmcook@gmail.com>

amoeba temporarily deployed to snapshot

January 22, 2026 21:32

— with

GitHub Actions Inactive

amoeba added 2 commits

January 22, 2026 19:29


          Add note about purge

59f1eed


          Add API keys section

6b14ceb

amoeba temporarily deployed to snapshot

January 23, 2026 03:29

— with

GitHub Actions Inactive


          Update docs/guides/private_drivers.md

Co-authored-by: Matt Topol <zotthewizard@gmail.com>

amoeba temporarily deployed to snapshot

January 23, 2026 03:29

— with

GitHub Actions Inactive


          proforead

f9bda38

amoeba temporarily deployed to snapshot

January 23, 2026 03:32

— with

GitHub Actions Inactive


          Update cli.md

78dca5c

amoeba temporarily deployed to snapshot

January 23, 2026 03:34

— with

GitHub Actions Inactive


          add note about account

da0dc54

amoeba temporarily deployed to snapshot

January 23, 2026 03:37

— with

GitHub Actions Inactive

amoeba marked this pull request as ready for review

January 23, 2026 03:38

Member Author

amoeba commented Jan 23, 2026

Okay I've marked this as ready for review. I'll take a read through tomorrow and would appreciate anyone who wants to take a look as well.


          Fix broken link

26ee157

ianmcook temporarily deployed to snapshot

January 23, 2026 05:51

— with

GitHub Actions Inactive

ianmcook approved these changes

View reviewed changes

Member

ianmcook left a comment

Looks great, thanks for doing this!

Member

ianmcook commented Jan 23, 2026

Let's wait to merge this until we're ready to release 0.2.0.

ianmcook reviewed

View reviewed changes

docs/guides/private_drivers.md Outdated Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/reference/cli.md Outdated Show resolved Hide resolved

ianmcook reviewed

View reviewed changes

docs/reference/cli.md Show resolved Hide resolved


          Add warning about purge

69c90b1

amoeba temporarily deployed to snapshot

January 23, 2026 20:42

— with

GitHub Actions Inactive


          Update docs/reference/cli.md

1e29238

Co-authored-by: Ian Cook <ianmcook@gmail.com>

amoeba temporarily deployed to snapshot

January 23, 2026 20:43

— with

GitHub Actions Inactive


          Don't highlight shell built-ins

d23527c

amoeba temporarily deployed to snapshot

January 23, 2026 20:55

— with

GitHub Actions Inactive

Member Author

amoeba commented Jan 23, 2026 •

edited by ianmcook

Loading

All review feedback is addressed, todos here are,

Check that my edit in docs: document auth command, private drivers #263 (comment) is acceptable
Wait until we're ready for 0.2.0

Then we can merge.

amoeba requested a review from ianmcook

January 23, 2026 20:59

zeroshade approved these changes

View reviewed changes

ianmcook approved these changes

View reviewed changes

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

Labels

None yet