Skip to content

Commit cb1e82b

Browse files
bordumbclaude
andcommitted
docs: fix stale metadata (versions, URLs, completions, package dirs)
- Replace "completions planned" with actual `auths completions` usage - Update version 0.0.1-rc.5 → 0.0.1-rc.10 in install.md - Update version 0.0.1-rc.3 → 0.0.1-rc.10 in project-structure.md - Fix packages/ listing: auths-verifier-python → auths-python, add auths-node - Fix clone URL: AuThs-protocol → auths-dev Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 165351f commit cb1e82b

3 files changed

Lines changed: 33 additions & 8 deletions

File tree

docs/contributing/development-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This guide walks through setting up a local development environment for Auths.
2222
## Clone and build
2323

2424
```bash
25-
git clone https://github.com/AuThs-protocol/auths.git
25+
git clone https://github.com/auths-dev/auths.git
2626
cd auths
2727
cargo build
2828
```

docs/contributing/project-structure.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@ auths/
2222
│ └── xtask/ Build automation tasks (publish = false)
2323
2424
├── packages/
25-
│ ├── auths-verifier-python/ Python bindings (PyO3)
26-
│ ├── auths-verifier-ts/ TypeScript bindings (WASM)
27-
│ ├── auths-verifier-go/ Go bindings (CGo)
28-
│ ├── auths-verifier-swift/ Swift/Kotlin bindings (UniFFI)
25+
│ ├── auths-python/ Python SDK (PyO3/maturin)
26+
│ ├── auths-node/ Node.js SDK (napi-rs)
27+
│ ├── auths-verifier-ts/ TypeScript verification bindings (WASM)
28+
│ ├── auths-verifier-go/ Go verification bindings (CGo)
29+
│ ├── auths-verifier-swift/ Swift/Kotlin verification bindings (UniFFI)
2930
│ └── auths-mobile-swift/ iOS identity creation (UniFFI)
3031
3132
├── docs/ MkDocs documentation
@@ -122,6 +123,6 @@ Bindings: packages/auths-verifier-{python,ts,go,swift}
122123

123124
All crates share a workspace `Cargo.toml` at the repository root. Common dependencies and versions are declared under `[workspace.dependencies]`:
124125

125-
- Current workspace version: `0.0.1-rc.3`
126+
- Current workspace version: `0.0.1-rc.10`
126127
- Rust edition: 2024 (implied by `rust-version = "1.93"`)
127128
- Workspace resolver: `3`

docs/getting-started/install.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,31 @@ Pre-built binaries for macOS, Linux, and Windows are available on the
8888

8989
## Shell Completions
9090

91-
Shell completions are planned for a future release.
91+
Generate shell completions for your shell:
92+
93+
=== "Bash"
94+
95+
```bash
96+
auths completions bash > ~/.local/share/bash-completion/completions/auths
97+
```
98+
99+
=== "Zsh"
100+
101+
```bash
102+
auths completions zsh > ~/.zfunc/_auths
103+
```
104+
105+
=== "Fish"
106+
107+
```bash
108+
auths completions fish > ~/.config/fish/completions/auths.fish
109+
```
110+
111+
=== "PowerShell"
112+
113+
```powershell
114+
auths completions powershell > $PROFILE.CurrentUserAllHosts
115+
```
92116

93117
## Verify Installation
94118

@@ -99,7 +123,7 @@ auths --version
99123
Expected output:
100124

101125
```
102-
auths 0.0.1-rc.5
126+
auths 0.0.1-rc.10
103127
```
104128

105129
!!! tip

0 commit comments

Comments
 (0)