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.

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

api docs should have a page for class @web3-storage/access Agent and other packages/classes (not just @web3-storage/w3up-client as today) #1139

Closed
gobengo opened this issue Nov 15, 2023 · 2 comments
Closed

api docs should have a page for class @web3-storage/access Agent and other packages/classes (not just @web3-storage/w3up-client as today) #1139

gobengo opened this issue Nov 15, 2023 · 2 comments
Assignees
@gobengo

Comments

@gobengo
Copy link
Contributor

gobengo commented Nov 15, 2023 •
edited
Loading

Expected Behavior

Actual Beahvior:

  • I can only click to classes for @web3-storage/w3up-client package but not access or other packages (see screenshot below)
@gobengo
Copy link
Contributor Author

gobengo commented Nov 15, 2023

nvm it works but like https://web3-storage.github.io/w3up/classes/_web3_storage_w3up_client.client.Client.html

but the packages other than @web3-storage/w3up-client (e.g. @web3-storage/access) don't seem to have api docs for individual submodules and classes. That's probably an accident.
Screenshot 2023-11-15 at 11 27 01 AM

@gobengo gobengo changed the title github actions should deploy docs to w3up github pages api docs should have a page for class @web3-storage/access Agent and other packages/classes (not just @web3-storage/w3up-client as today) Nov 15, 2023
@gobengo gobengo self-assigned this Nov 15, 2023
This was referenced Nov 15, 2023
Merged
Merged
gobengo added a commit that referenced this issue Nov 15, 2023
@gobengo
fix: issue where typedoc docs would only show full docs for w3up-clie…
0b8d3f3 
…nt (#1141)

…and not other packages

Motivation:
* #1139

Rationale:
* I think it is my fault from March when I moved w3up-client into this
monorepo
* The monorepo root `tsconfig.json` uses `"entryPointStrategy":
"packages"`, which requires each subpackage to have its own
`tsconfig.json` `"typedocOptions": {
    "entryPoints": ["./src"]
  }`
  * I missed this last time.
@gobengo gobengo closed this as completed Nov 16, 2023
@gobengo
Copy link
Contributor Author

gobengo commented Nov 28, 2023

expected behavior now met at https://web3-storage.github.io/w3up/classes/_web3_storage_access.Agent.html

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

@gobengo gobengo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gobengo