Skip to content

docs: replace custom rustdocs with official links #59

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

Merged
bordumb merged 1 commit into from
Mar 9, 2026
Merged

docs: replace custom rustdocs with official links #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,6 @@ jobs:
- name: Regenerate CLI docs
run: cargo run -p xtask -- gen-docs

- name: Build rustdoc
run: cargo doc --no-deps -p auths-sdk -p auths-core -p auths-crypto -p auths-verifier -p auths-id
env:
RUSTDOCFLAGS: "-D warnings"

- uses: actions/setup-python@v5
with:
python-version: '3.12'
Expand All @@ -68,18 +63,3 @@ jobs:
- name: Build mkdocs
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
run: mkdocs build --strict

- name: Merge rustdoc into site
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
run: |
mkdir -p site/rustdoc
cp -r target/doc/* site/rustdoc/
echo '<meta http-equiv="refresh" content="0; url=auths_sdk">' > site/rustdoc/index.html
touch site/.nojekyll

- name: Deploy to GitHub Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
14 changes: 7 additions & 7 deletions docs/sdk/rust/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Rust API Reference

The full Rust API reference is generated from source via rustdoc.
The full Rust API reference is hosted on docs.rs.

**[Browse the API reference →](/rustdoc/auths_sdk/)**
**[Browse the API reference →](https://docs.rs/auths-sdk/latest/auths_sdk/)**

## Key Crates

| Crate | Description |
|---|---|
| [auths-sdk](/rustdoc/auths_sdk/) | Application services layer — start here |
| [auths-core](/rustdoc/auths_core/) | Keychain, device pairing, trust model |
| [auths-crypto](/rustdoc/auths_crypto/) | Ed25519 signing, DID encoding |
| [auths-verifier](/rustdoc/auths_verifier/) | Attestation chain verification |
| [auths-id](/rustdoc/auths_id/) | KERI Key Event Log management |
| [auths-sdk](https://docs.rs/auths-sdk/latest/auths_sdk/) | Application services layer — start here |
| [auths-core](https://docs.rs/auths-core/latest/auths_core/) | Keychain, device pairing, trust model |
| [auths-crypto](https://docs.rs/auths-crypto/latest/auths_crypto/) | Ed25519 signing, DID encoding |
| [auths-verifier](https://docs.rs/auths-verifier/latest/auths_verifier/) | Attestation chain verification |
| [auths-id](https://docs.rs/auths-id/latest/auths_id/) | KERI Key Event Log management |