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

Formal documentation? #86

Open
bruceharrison1984 opened this issue Feb 21, 2024 · 3 comments
Open

Formal documentation? #86

bruceharrison1984 opened this issue Feb 21, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@bruceharrison1984
Copy link
Contributor

bruceharrison1984 commented Feb 21, 2024

What is the feature you are proposing?

The current readme is getting pretty long. Can we get a formal documentation repo (similar to Hono) to start moving some of this stuff over?

Or perhaps add a section to the Hono docs specifically for HonoX.

@bruceharrison1984 bruceharrison1984 added the enhancement New feature or request label Feb 21, 2024
@yusukebe
Copy link
Member

Hi @bruceharrison1984

We don't have to do it "right now", but we should do it soon.

I think those are the two options:

  1. Add a section to Hono's website for HonoX.
  2. Create a new HonoX website using "HonoX".

If we chose "1", we can add that here:

Screenshot 2024-02-23 at 6 09 14

The most likely way is to do "1" first and then "2" later.

@KaiSpencer
Copy link

I think whilst this is all very new, people might find honox more by a shiny new button in the hono docs.

Until honox matures its probably best to stick simply and turn the readme into a page with sections from the hono top nav

@bruceharrison1984
Copy link
Contributor Author

@KaiSpencer I agree. I think just carving out a section in the existing docs, similar to some of the middleware, would work for quite some time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants