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

Improve Developer Documentation #11

Closed
wants to merge 6 commits into from
Closed

Improve Developer Documentation #11

wants to merge 6 commits into from

Conversation

jhdcruz
Copy link

@jhdcruz jhdcruz commented Mar 2, 2022

Changelogs:

  • i18n menu dropdown

    • currently only has en.
  • Add local search bar functionality.

    • The docs currently doesn't have much content, so local search should suffice.
    • NOTE!: Updated docusaurus monorepo to 2.0.0-beta.16.

Unfortunately, the search bar functionality doesn't work in development mode (yarn start).

  • Refine docs formatting
    • Added admonitions on key content.
    • Minor sidebar re-ordering (FAQ's now on top/pinned)
    • Removed emojis (much cleaner looking?, but can be reverted...)
  • Fix broken links.

Suggestions

  • Additional docs translations

    • Currently there are only en_US translation available, consider adding more languages
  • Migrate the local search bar functionality to Algolia DocSearch

    • Registration is required so I didn't go for this route directly.

+ Updated docusaurus monorepo to 2.0.0-beta.16

NOTE: Migrate to algolia search, only maintainers are allowed to do this since
registration is required: https://docsearch.algolia.com/apply/
@jhdcruz jhdcruz marked this pull request as ready for review March 2, 2022 10:54
This pull request was closed.
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.

None yet

2 participants