📒 Documentation

[jd-solanki]

Describe the feature

Hi 👋🏻

I'm fan of creating CLI application. I have typer library that does really good job in python. In JS, I plan to use citty but there's lack of documentation for me & my colleagues to get started and fully leverage it.

Can we have a dedicated documentation site for citty like unstorage & others?

P.S. Some of the unjs projects don't have enough docs to understand the value it provides 😞

Additional information

• Would you be willing to help implement this feature?

[amandesai01]

I went through the source code and found it pretty straight forward. However, it totally makes sense to have a documentation since not everyone should be supposed to read source code. I would be more than happy to contribute with initial documentation.

[NozomuIkuta]

@amandesai01

UnJS team is planning to develop its website for the ecosystem.
It's appreciated if you list up some points that you think should be included in the docs here, so that the team can take them into consideration.

[jd-solanki]

Here's how we can cover most of the community (according to me):

• Beginner/GettingStarted Example
• Explaning features with example & some description
• Full API

I guess this covers the most of the documentation for beginner to advanced devs.

[pi0]

@jd-solanki PR is more than welcome to improve documentation (directly in citty/README.md)

---

Re unjs documentation @NozomuIkuta mentioned, we are thinking about two things: Exposing auto generated (tsdoc) API and render it in several places (library, unjs, nitro, nuxt) and using remote source feature of docus which is used to render docs (docs still live in repo README.md or docs/ dir but remotely fetched and rendered)

[Barbapapazes]

P.S. Some of the unjs projects don't have enough docs to understand the value it provides 😞

Hey @jd-solanki, could you tell me which one? I'm currently writting content about UnJS packages (see unjs/website#110). Thanks 🙏

[jd-solanki]

Thanks @Barbapapazes for writing content.

• citty
• https://github.com/unjs/knitwork
• https://github.com/unjs/magicast
• https://github.com/unjs/unctx - I think this has great potential if we can provide practicle example
• How to use c12 when building library

I guess that's enough

[Barbapapazes]

Thanks for the response!

• citty, currently on hold since the API must be stabilized. So I can't give you an ETA.
• knitwork, I will need to deep dive into it to find how to explain it with a real use case.
• magicast, same as knitwork (could have an idea but it require citty). I could create a build article in the following weeks.
• unctx, I don't know a lot about this package. I don't know where it is used. Not on top of my list.
• c12, a 101 could be out soon but I want to introduce rc9 before. As a build article, we could create a meta framework from scratch and I will try to find more examples.

Currently, I'm on unbuild, h3 and soon nitro (expected 2 or 3 weeks of works before I could take a look to others packages).

[pi0]

c12, a 101 could be out soon but I want to introduce rc9 before. As a build article, we could create a meta framework from scratch and I will try to find more examples.

I would suggest writing about c12. It can cover rc9 as well as many other goodies powering Nuxt 3 and Nitro features.

[Barbapapazes]

Hello @jd-solanki, I opened a PR, #70, to add more content about the usage of citty. Do not hesitate to tell me if this first draft is understandable or if I need to explain more!

(This is not the getting started guide)

[jd-solanki]

Hi @Barbapapazes

I reviewed the PR and must say it was very satisfying. I didn't knew some of the stuff you mentioned. Great work 🫡

[Barbapapazes]

Hi @Barbapapazes

I reviewed the PR and must say it was very satisfying. I didn't knew some of the stuff you mentioned. Great work 🫡

Thanks for the review! I will update PR with them.