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

init docs site #585

Merged
merged 2 commits into from
Mar 10, 2021
Merged

init docs site #585

merged 2 commits into from
Mar 10, 2021

Conversation

Ethan-Arrowood
Copy link
Collaborator

@Ethan-Arrowood Ethan-Arrowood commented Mar 3, 2021

First stab at generating a docs site from the markdown documents. Docsify seems cool and I like the DX so far. I'll get a github actions thing working soon so it "auto deploys" on new commits and such

Check out the live preview: http://ethanarrowood.com/undici/#/

@codecov-io
Copy link

codecov-io commented Mar 4, 2021

Codecov Report

Merging #585 (e6d32fc) into master (db17e6d) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #585   +/-   ##
=======================================
  Coverage   99.15%   99.15%           
=======================================
  Files          16       16           
  Lines        1425     1425           
=======================================
  Hits         1413     1413           
  Misses         12       12           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update db17e6d...e6d32fc. Read the comment docs.

docs/README.md Outdated Show resolved Hide resolved
@ronag
Copy link
Member

ronag commented Mar 9, 2021

@Ethan-Arrowood how are we doing with the docs stuff? I was thinking we do a 4.0 release once wasm has been merged (hopefully next week 🤞 ). Do we want to include the new docs in that?

@mcollina
Copy link
Member

mcollina commented Mar 9, 2021

That would be amazing.

@Ethan-Arrowood
Copy link
Collaborator Author

Yes I'd love to make that all happen together. I'll try and send Agent docs ASAP as well as wrap up this site deployment work

@Ethan-Arrowood
Copy link
Collaborator Author

Live preview available here: http://ethanarrowood.com/undici/#/

@mcollina or @ronag will need to enable GitHub Pages for the root directory once this is merged + we will need to set a custom domain. I think we should use undici.nodejs.org or undici.dev

@Ethan-Arrowood
Copy link
Collaborator Author

We could also use a logo 😉

Copy link
Contributor

@dnlup dnlup left a comment

Choose a reason for hiding this comment

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

This looks amazing!

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@ronag
Copy link
Member

ronag commented Mar 10, 2021

Why does CI fail?

@mcollina
Copy link
Member

It passes now!

@mcollina mcollina merged commit e35706c into nodejs:master Mar 10, 2021
Ethan-Arrowood added a commit to Ethan-Arrowood/undici that referenced this pull request Mar 15, 2021
* init docs site

* move docsify to root
crysmags pushed a commit to crysmags/undici that referenced this pull request Feb 27, 2024
* init docs site

* move docsify to root
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.

5 participants