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

Implement add-ons to improve developer engagement #211

Closed
14 tasks
LakshmiLavanyaKasturi opened this issue Nov 3, 2022 · 4 comments
Closed
14 tasks

Implement add-ons to improve developer engagement #211

LakshmiLavanyaKasturi opened this issue Nov 3, 2022 · 4 comments
Assignees

Comments

@LakshmiLavanyaKasturi
Copy link
Contributor

LakshmiLavanyaKasturi commented Nov 3, 2022

Big thinking: site arch and UIUX.

API Try-it experience

  • Come up with Redoc tool or any other tool that can integrate with Docusaurus for a try-it experience.
  • UI/UX design on how the API Try-it experience would look like.
  • Design wireframes for high-level docs site vision.
  • Get the wireframe flow from the Hiro docs landing page to the product-specific documentation pages.
  • Check if docusaurus supports multi tiles on the documentation page. Eg: Top level tile would have How-to-articles and the lower level would have how-to-article-1, how-to-article-2 etc.
    Eg: https://developers.facebook.com/support/

Vote-up/down button. (Thumbs up/down)

  • Placement of the button.
  • Decide the text.
  • Thumbs down shows up a text box to enter a reason for thumbs down.
  • Work with UI/UX team to come up with the design for including this feature.
  • brainstorm if the following tools would be sufficient. amplitude, hotjar, Google analytics

Product Changelog

  • Work with Marketing (Elena, Max, Brian) to determine what content will be included in the Product Changelog
  • Decide where to place the link to the Product Changelog. Should it be added to the horizontal tabs at the top of the page? How about in the left navigation pane? Botton of the page?
  • Create Changelog Slack Channel and work with Elena and Max to create Slackbot to ping PMs and Engineering Managers weekly to add any updates.
  • Changelog responsibilities will alternate between Lavanya and Thomas on a monthly basis
@LakshmiLavanyaKasturi LakshmiLavanyaKasturi changed the title Brainstorm - API Try-it experience Brainstorm - Big thinking site architecture Nov 3, 2022
@LakshmiLavanyaKasturi
Copy link
Contributor Author

@trichards-hiro Can you add change log notes to this user story?

@sabbyanandan sabbyanandan changed the title Brainstorm - Big thinking site architecture Implement add-ons to improve developer engagement Jan 10, 2023
@sabbyanandan
Copy link
Contributor

I bumped into a conversation of how the React's website includes a voting component, and how they implemented it in Docusaurus. While digging, I ran into this facebook/react-native-website#3371, that supposedly adds the vote component, which can be used as a reference when implementing this in our Docs.

@LakshmiLavanyaKasturi
Copy link
Contributor Author

The design draft for the thumbs-up and down feature is documented here. .

@LakshmiLavanyaKasturi
Copy link
Contributor Author

LakshmiLavanyaKasturi commented Jan 24, 2023

Closing this big-picture issue as we have smaller issues created from this for easy tracking.

#266.
#191
#265

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

No branches or pull requests

3 participants