search

thunderbird / developer-docs

Developer documentation for Thunderbird contributors.
https://developer.thunderbird.net
80 stars 77 forks source link

Fix #74 Add a quicker way to access MailExtension API reference #77

Closed dannycolin closed 4 years ago

jobisoft commented 4 years ago

Thanks for your comment and suggestion. However, I think it breaks the concept, but this is just my impression.

New users, who have no idea what MailExt API is, will learn about it directly on the introduction page. And there is a link, which wil take them to the API documentation directly. Experienced users can set a bookmark to the API documentation, if they want to access it directly, no need to go via DTN.

Background: We just reduced the main menu structure because there was too much stuff on the first level, which made navigating very difficult.

dannycolin commented 4 years ago

Experienced users can set a bookmark to the API documentation Background: We just reduced the main menu structure because there was too much stuff on the first level, which made navigating very difficult.

The first time I visited the documentation website, even as an experienced user, it wasn't great. Since I already knew about webextension, I didn't think the information would be in "introduction" or in "additional documentation". This makes me overlook it when I first read the introduction page.

So, maybe a good compromise to avoid undoing your effort to reduce the menu could be to add a more prominent message/link on the introduction page. It could be a box right under the "What are addon?" section saying something like "Already know how it works... go straight to the API reference" or something like that. What do you think?

jobisoft commented 4 years ago

I moved the documentation link one position up and removed "additional" to indicate that this link is for the main documentation. I do not want to add an extra link just for the API into the main navigation. Is that ok for you? Any alternative suggestion for the wording of the link names?

dannycolin commented 4 years ago

I moved the documentation link one position up and removed "additional" to indicate that this link is for the main documentation.

The new wording is perfect. It takes away the confusion added by "additional" where it could be interpreted as optional. I think we can now close the issue.

Thanks a lot :).