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

create new docs website #2190

Closed
5 of 6 tasks
heyjay44 opened this issue Jan 20, 2023 · 1 comment
Closed
5 of 6 tasks

create new docs website #2190

heyjay44 opened this issue Jan 20, 2023 · 1 comment
Assignees
@yusefnapora
Milestone
w3up phase 2

Comments

@heyjay44
Copy link
Contributor

heyjay44 commented Jan 20, 2023 •
edited by yusefnapora
Loading

Problem Statement

We need a place to point users who are using the new stuff. We currently don't have this.

Proposed Work

P0 - a site with the client docs generated (ready for Jan 27)
P1 - continue adding docs, in order of priority, to this skeleton site

Success Criteria

A website where all required documentation for the new world is available so that users can easily pick up our products and use them.

First round to include:

  • quick start for CLI & w3up-client
  • overview of w3ui
  • generated API docs (typedoc) for:
    • w3protocol:
      • capabilities
      • access-client
      • upload-client
    • w3up-client
@heyjay44 heyjay44 added this to the w3up phase 2 milestone Jan 20, 2023
@heyjay44 heyjay44 mentioned this issue Jan 20, 2023
Closed
95 tasks
This was referenced Jan 23, 2023
Closed
Merged
yusefnapora added a commit to storacha/w3up that referenced this issue Jan 24, 2023
@yusefnapora
chore: add config to generate markdown API docs (#389)
6e83725 
This adds a minimal [docusaurus](https://docusaurus.io) config file that
allows us to use
[docusaurus-plugin-typedoc](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc)
to generate markdown files that are compatible with docusaurus.

**Context**

As part of web3-storage/web3.storage#2190, I
want to render the typedoc outputs for all our "user facing" packages.
The idea is that I would make a shallow clone of this repo when building
the docs site and run `pnpm run docs:markdown` to generate the markdown
files, then copy them into the content dir, along with the outputs of
`w3up-client` and whatever other packages we end up putting in there.

The plugin really wants to be part of a docusaurus project, but it will
run with just the `@docusaurus/core` dependency and a minimal config
file. `@docusaurus/core` has a peer dependency on `react` and
`react-dom`, so I added some [pnpm
config](https://pnpm.io/package_json#pnpmpeerdependencyrules) to ignore
missing react peer deps.


Here's a quick screenshot of my WIP docs build, as a teaser of things to
come:


![image](https://user-images.githubusercontent.com/678715/214158679-2442f419-1ab7-45df-a2ce-188a4c0de40a.png)
@yusefnapora yusefnapora mentioned this issue Jan 24, 2023
Merged
@yusefnapora
Copy link
Contributor

New docs repo is at https://github.com/web3-storage/w3up-docs with deploy preview at https://keen-sundae-c3a11f.netlify.app/

Will make issues in the new repo to track remaining P1/P0 work & close this issue once that's done.

gobengo pushed a commit to storacha/w3up that referenced this issue Apr 11, 2023
@yusefnapora
chore: add config to generate markdown API docs (#389)
7895a8a 
This adds a minimal [docusaurus](https://docusaurus.io) config file that
allows us to use
[docusaurus-plugin-typedoc](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc)
to generate markdown files that are compatible with docusaurus.

**Context**

As part of web3-storage/web3.storage#2190, I
want to render the typedoc outputs for all our "user facing" packages.
The idea is that I would make a shallow clone of this repo when building
the docs site and run `pnpm run docs:markdown` to generate the markdown
files, then copy them into the content dir, along with the outputs of
`w3up-client` and whatever other packages we end up putting in there.

The plugin really wants to be part of a docusaurus project, but it will
run with just the `@docusaurus/core` dependency and a minimal config
file. `@docusaurus/core` has a peer dependency on `react` and
`react-dom`, so I added some [pnpm
config](https://pnpm.io/package_json#pnpmpeerdependencyrules) to ignore
missing react peer deps.


Here's a quick screenshot of my WIP docs build, as a teaser of things to
come:


![image](https://user-images.githubusercontent.com/678715/214158679-2442f419-1ab7-45df-a2ce-188a4c0de40a.png)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yusefnapora yusefnapora

Labels
None yet
Projects
None yet
Milestone
w3up phase 2
Development

No branches or pull requests
2 participants
@yusefnapora @heyjay44