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

Add docs configuration and visualization #106 #114

Merged
merged 4 commits into from
Feb 8, 2022
Merged

Add docs configuration and visualization #106 #114

merged 4 commits into from
Feb 8, 2022

Conversation

luizstacio
Copy link
Member

@luizstacio luizstacio commented Feb 7, 2022

Description

Add visual documentation to improve DX. To make it as present as possible, also docs are made in markdown.

Documatation preview on the forked repository.

Sorry on long PR 😅

Summary

  • Create package typedoc-monorepo-link-types to create link cross package and add non exported classes on docs, to a better understanding of params and returns.
  • Create package typedoc-just-the-docs-theme to organize Files in Folders and configure YML Front Matter with navigation info.
  • Add _config.yml to auto-generate page using gh-pages with Jekyll.
  • Add some custom color schema and images
  • Add docs to packages wallet, and providers will open another PR with other files after to not overhead this one.
  • Add home page to the docs under docs folder. It's also possible to create pages as necessary to tutorials and other Infos.

Github configuration required

  • Set on settings > pages. branch: master and folder:/docs.

@luizstacio luizstacio self-assigned this Feb 7, 2022
@luizstacio luizstacio linked an issue Feb 7, 2022 that may be closed by this pull request
@luizstacio luizstacio changed the title Add docs configuration and visualization #113 Add docs configuration and visualization #106 Feb 7, 2022
@luizstacio luizstacio merged commit 0d1a623 into FuelLabs:master Feb 8, 2022
@luizstacio luizstacio deleted the feat/add-docs branch February 15, 2022 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add documentation with jsdoc or typedocs
2 participants