-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
docs: move from jekyll pages to a better doc engine #457
Comments
Nextra seems to be an excellent solution, but I have never used it. I've seen a couple of projects using it, and also on our other repos:
@FuelLabs/frontend Do you have any pros and cons you'd like to point out about the tool? @FuelLabs/sdk-ts Anyone else with experience using Nextra? |
I guess we could improve the next project we have inside the wallet and try to use it as a base for all projects. Could be a template, a boilerplate, a generator, or even a tool. But it will be essential in order to have standard docs across the entire organization. |
@pedronauck Excellent point. I like the sound of it, but I wonder how complicated that would be. |
Another candidate could be Vite Press: It has many goodies for Markdown, |
I have used Nextra multiple times in the past, but never with anything along the lines of auto-generated docs. |
Yes, in this case, we wouldn't be auto-generating docs from JavaDoc style annotations via TypeDoc anymore, but writing everything by hand and using code snippets where applicable to denote methods usage and whatnot. I would be OK with throwing TypeDoc away and stopping using those styles of API documentation, which, IMO, are not very useful. These generated docs are often vague and mechanical and do not seem to provide advantages beyond what one could get by reading the source code directly. @Dhaiwat10 What are your thoughts about Nextra? Did you have a good experience using it? Any experience comparing it with other tools such as VitePress or similar? |
@luizstacio mentioned docusaurus as a good candidate for this |
* preview * fixed images and order * updates * bump images * docs: Add verified assets (#453) * ready for review * fix * ready for review * update submodules
Items;
### Full SDK Installation
and reuse them inside packagesREADME
fileNotes;
The text was updated successfully, but these errors were encountered: