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

Documentation: "Tutorials section >> docs" #2806

Merged
merged 10 commits into from
Apr 28, 2024
Merged

Conversation

daveads
Copy link
Contributor

@daveads daveads commented Apr 25, 2024

  • Did some Restructuring the sidebar and made sidebar.js a bit easier to read
  • created a Tutorial section and move "Testing HTTP Applications" into it
  • Added DocCardList to Reference and Example section

DocCardList looks like the below
Screenshot 2024-04-25 at 16-38-07 Zio http Reference zio-http-docs-website

@daveads daveads changed the title Tutorials docs Documentation: "Tutorials docs" Apr 25, 2024
@daveads daveads changed the title Documentation: "Tutorials docs" Documentation: "Tutorials section >> docs" Apr 25, 2024
@987Nabil
Copy link
Contributor

@khajavi can you take a look please

@khajavi
Copy link
Member

khajavi commented Apr 27, 2024

@daveads Just ping me to review after resolving the conflicts.

@codecov-commenter
Copy link

codecov-commenter commented Apr 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.28%. Comparing base (d283e07) to head (d7f606d).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2806   +/-   ##
=======================================
  Coverage   64.28%   64.28%           
=======================================
  Files         155      155           
  Lines        9086     9086           
  Branches     1586     1586           
=======================================
  Hits         5841     5841           
  Misses       3245     3245           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@daveads
Copy link
Contributor Author

daveads commented Apr 27, 2024

@khajavi you can check it out now...

@daveads
Copy link
Contributor Author

daveads commented Apr 27, 2024

we will move overveiw which was formally index.md later just like you earlier discussed

Screenshot 2024-04-27 at 14-01-47 Zio http Reference zio-http-docs-website

docs/examples/index.md Outdated Show resolved Hide resolved
docs/reference/index.md Outdated Show resolved Hide resolved
docs/sidebars.js Outdated
"reference/overview",
"reference/server",
"reference/client",
"reference/handler",
Copy link
Member

Choose a reason for hiding this comment

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

I would suggest placing the handler after the routing section for better organization.

@khajavi
Copy link
Member

khajavi commented Apr 28, 2024

@daveads Added some suggestions and comments.

daveads and others added 3 commits April 28, 2024 14:50
@daveads
Copy link
Contributor Author

daveads commented Apr 28, 2024

@daveads Added some suggestions and comments.

Done

@987Nabil 987Nabil merged commit 65dc08d into zio:main Apr 28, 2024
25 checks passed
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.

4 participants