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: Documentation website proposal #2965

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

gsi-alejandro
Copy link

image

Documentation website proposal:

Live example here

Features:

  • Landing page (stunning and simple)
  • Internationalization
  • Easier to maintain
  • Dark/Light theme support
  • Auto-deployment via github-actions
  • Searchable (not implemented yet, see notes)
  • Powered by Docusaurus 3.0

Notes:

  • Translations were generated using Crowdin, for now just Spanish and French languages were added, but we can add more, just provide a list with the languages.
  • To implement the search feature we need to create an Algolia account in order to get the API Key for the integration, if we agree I can add it.
  • A new workflow was added to automate the deployment, this only will be triggered when new code is merged into the master branch and the /docs folder has at least 1 change. This way the documentation will be deployed only when needed.
  • Live Example will be removed after this PR is approved/rejected. It's only a live demo.

Warnings:

  • The branch gh-pages will be updated after merging this PR into the master branch and it will deploy the website automatically to this URL https://jonataslaw.github.io/getx/
  • Notice that I didn't review translated files, just generated them from the English source, this means that some specific information added directly to the languages will be no reflected in this proposal.

Feel free to share any suggestions or feedback

It's a way to contribute and say thank you @jonataslaw and the community for your dedication and hard work.

It's just a bit I will keep contributing based on issues, feedback, and suggestions.

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

Successfully merging this pull request may close these issues.

1 participant