documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Rename `Learn` section

Open guimachiavelli opened this issue 3 years ago • 6 comments

Once #1304 is merged, we will have two main links in our top nav:

  • Learn
  • Reference

In combination with #1294, #1304 greatly increased the breadth of content under the Learn heading, to the point it is an awkward description that doesn't really give users a good understanding of what they'll find in that section.

We should rename it to something more descriptive. Let's gather some ideas here and discuss/vote on them later.

Current suggestions:

  • Guides

guimachiavelli avatar Nov 24 '21 13:11 guimachiavelli

I like guides, I think it is the most known and also very clear in what you are going to find inside

bidoubiwa avatar Nov 25 '21 19:11 bidoubiwa

Some sites refer to their non-API documentation as just "docs", e.g. on Stripe's API reference, you click a button that says "Docs" to return to the main site.

I don't like it as much as "guides" since it can be confusing—isn't everything on the docs site documentation? 🤔—but I like that it's a little more vague than "guides". I worry that "guides", while pretty vague, is still a little too specific to encompass everything outside of the reference.

In any case, I think "guides" is our top candidate at this point, and would probably be a good start. We can always refine it later.

dichotommy avatar Nov 30 '21 10:11 dichotommy

Yes I agree, sometimes I see docs as well and you are right it is quite confusing. Unless it is on their main website but then you are redirected to a docusaurus/vuepress like website in which everything becomes doc. Guide seems to be a good start while maybe not the perfect one yet

bidoubiwa avatar Nov 30 '21 11:11 bidoubiwa

I noticed that many websites with a "Guides" section have a "Quick Start"/"Getting Started" section as well. Examples:

Maybe we could go with this?

maryamsulemani97 avatar Apr 07 '22 12:04 maryamsulemani97

@dichotommy, I think this could a good and relatively simple to do. Perhaps something we can discuss in the next Docs restructure meeting?

guimachiavelli avatar Mar 29 '23 15:03 guimachiavelli

Discussed with @guimachiavelli We want to have more information about devhub before knowing what do to with this issue. We indeed want to rename the section but we need to know more about devhub to make a decision

curquiza avatar Oct 31 '23 10:10 curquiza