Skip to content
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.

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

chore: add about section & usage examples to access-client readme #261

Merged
merged 5 commits into from
Dec 13, 2022

Conversation

yusefnapora
Copy link
Contributor

@yusefnapora yusefnapora commented Dec 6, 2022

This adds an About section with some context about the access-client and how it fits into the bigger picture.

It also adds some detail to the Usage section, which now has subsections for creating Agents & Spaces and registering Spaces with the access service.

Closes #251

@yusefnapora
Copy link
Contributor Author

Added a bit about delegation and importing delegations from others. I get a bunch of type errors trying to run typedoc at the moment - it can't find a bunch of things in the new capabilities package, although the config looks correct to me.

I might poke at it this afternoon if nobody else is on it, although maybe this is the type issue that @hugomrdias was talking about yesterday.

@yusefnapora
Copy link
Contributor Author

Turns out my type errors were caused by not running pnpm run build before pnpm run docs. Made a tiny PR to always build first: #266

Copy link
Member

@alanshaw alanshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM - please address the feedback and feel free to merge.

packages/access-client/readme.md Outdated Show resolved Hide resolved
packages/access-client/readme.md Outdated Show resolved Hide resolved
packages/access-client/readme.md Outdated Show resolved Hide resolved
packages/access-client/readme.md Outdated Show resolved Hide resolved
@yusefnapora yusefnapora merged commit 02704e1 into main Dec 13, 2022
@yusefnapora yusefnapora deleted the docs/access-client-readme branch December 13, 2022 18:29
gobengo pushed a commit that referenced this pull request Apr 11, 2023
This adds an About section with some context about the access-client and
how it fits into the bigger picture.

It also adds some detail to the Usage section, which now has subsections
for creating Agents & Spaces and registering Spaces with the access
service.

Closes #251
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

review and update access-client README
3 participants