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

docs: move from jekyll pages to a better doc engine #457

Closed
3 tasks
luizstacio opened this issue Aug 15, 2022 · 7 comments · Fixed by #811
Closed
3 tasks

docs: move from jekyll pages to a better doc engine #457

luizstacio opened this issue Aug 15, 2022 · 7 comments · Fixed by #811
Assignees
Labels
docs Requests pertinent to documentation

Comments

@luizstacio
Copy link
Member

luizstacio commented Aug 15, 2022

Items;

  • change typedoc to generate to the new temple engine
  • change the deploy config on gh-pages
  • make a reusable block for ### Full SDK Installation and reuse them inside packages README file

Notes;

  • One good template is the nextra.
@arboleya
Copy link
Member

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:

Congrats on these! @FuelLabs/frontend 🤘 🚀

@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?

@pedronauck
Copy link
Contributor

pedronauck commented Jan 27, 2023

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.

@arboleya
Copy link
Member

@pedronauck Excellent point.

I like the sound of it, but I wonder how complicated that would be.

@arboleya
Copy link
Member

Another candidate could be Vite Press:

It has many goodies for Markdown, import code snippets being one of them:

@Dhaiwat10
Copy link
Member

I have used Nextra multiple times in the past, but never with anything along the lines of auto-generated docs.

@arboleya
Copy link
Member

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?

@Torres-ssf
Copy link
Contributor

@luizstacio mentioned docusaurus as a good candidate for this

@Torres-ssf Torres-ssf self-assigned this Mar 8, 2023
petertonysmith94 pushed a commit that referenced this issue Nov 25, 2024
* preview

* fixed images and order

* updates

* bump images

* docs: Add verified assets (#453)

* ready for review

* fix

* ready for review

* update submodules
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants