Skip to content

dir docs refactor #433

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
keraron merged 4 commits into from
Mar 18, 2026
Merged

dir docs refactor #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
552a5e1
chore: merging records and validation
keraron Mar 12, 2026
6c5063c
chore: linking sdk packages
keraron Mar 12, 2026
2d049b4
chore: update api reference links
keraron Mar 12, 2026
002722e
added python sdk link
keraron Mar 13, 2026
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
1 change: 1 addition & 0 deletions .github/workflows/pr-links.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ jobs:
if: steps.get_paths.outputs.has_paths == 'true'
uses: lycheeverse/lychee-action@v2.0.2 # CVE-2024-48908: pin >=2.0.2
with:
lycheeVersion: "v0.22.0" # v0.16.x (action default) does not support --root-dir; added in v0.18
args: |
--no-progress
--config lychee.toml
Expand Down
3 changes: 1 addition & 2 deletions docs/dir/.index
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ nav:
- Components:
- Runtime Discovery: runtime.md
- Event Streaming: events.md
- Records: ads-records.md
- Validation: validation.md
- Records and Validation: records-validation.md
- Trust Model: trust-model.md
- CLI Reference: directory-cli.md
- GUI Application: directory-gui.md
Expand Down
69 changes: 0 additions & 69 deletions docs/dir/ads-records.md
View file
Open in desktop

This file was deleted.

10 changes: 1 addition & 9 deletions docs/dir/dir-api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
# Directory API Reference

For detailed API reference, see the following pages:

* [Core API Reference](https://buf.build/agntcy/dir/docs/main:agntcy.dir.core.v1)
* [Events API Reference](https://buf.build/agntcy/dir/docs/main:agntcy.dir.events.v1)
* [Routing API Reference](https://buf.build/agntcy/dir/docs/main:agntcy.dir.routing.v1)
* [Runtime API Reference](https://buf.build/agntcy/dir/docs/main:agntcy.dir.runtime.v1)
* [Search API Reference](https://buf.build/agntcy/dir/docs/main:agntcy.dir.search.v1)
* [Sign API Reference](https://buf.build/agntcy/dir/docs/main:agntcy.dir.sign.v1)
* [Store API Reference](https://buf.build/agntcy/dir/docs/main:agntcy.dir.store.v1)
The Directory API reference is available at [buf.build/agntcy/dir](https://buf.build/agntcy/dir).
10 changes: 5 additions & 5 deletions docs/dir/directory-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ The Directory SDK provides comprehensive libraries and tools for interacting wit

## JavaScript SDK

Documentation for the JavaScript SDK can be found on [GitHub](https://github.com/agntcy/dir/tree/main/sdk/dir-js). The SDK supports both JavaScript and TypeScript applications.
Documentation for the JavaScript SDK can be found on [GitHub](https://github.com/agntcy/dir/tree/main/sdk/dir-js). The SDK supports both JavaScript and TypeScript applications. The package is published on [npm](https://www.npmjs.com/package/agntcy-dir).

!!! note

The SDK is intended for use in Node.js applications and will not work in Web applications.
The SDK is intended for use in Node.js applications and does not work in web applications.

### Installation

Expand Down Expand Up @@ -57,8 +57,8 @@ const spiffeClient = new Client(config, transport);

## Python SDK

Documentation for the Python SDK can be found on [GitHub](https://github.com/agntcy/dir/tree/main/sdk/dir-py).
The SDK supports Python 3.10+ applications.
Documentation for the Python SDK can be found on [GitHub](https://github.com/agntcy/dir/tree/main/sdk/dir-py).
The SDK supports Python 3.10+ applications. The package is published on [PyPI](https://pypi.org/project/agntcy-dir/).

### Installation

Expand Down Expand Up @@ -106,7 +106,7 @@ client = Client(config)

## Go SDK

Documentation for the Go SDK can be found at [GitHub](https://github.com/agntcy/dir/tree/main/client).
Documentation for the Go SDK can be found at [GitHub](https://github.com/agntcy/dir/tree/main/client). The package is available on [pkg.go.dev](https://pkg.go.dev/github.com/agntcy/dir/client).

### Installation

Expand Down
Loading
Loading