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 docs: user-documentation/en/collect/jabref-browser-extension.md #444

Open
bf opened this issue Mar 13, 2023 · 2 comments
Open

Improve docs: user-documentation/en/collect/jabref-browser-extension.md #444

bf opened this issue Mar 13, 2023 · 2 comments

Comments

@bf
Copy link

bf commented Mar 13, 2023

I have installed jabref browser extension on a linux system twice in last week, once for myself and once for a friend.

Unfortunately the documentation for the browser installation feels not very user friendly and confusing. Even at the second installation (and native host configuration) for jabref we had to take a deep look into the docs at https://docs.jabref.org/collect/jabref-browser-extension#installation-and-configuration

I feel the docs for browser extension could really benefit from more structure. For example a sub-page for each operating system and then proper headlines for different browser configurations. Or a sub-page for each browser and then a proper headline for each operating system.

But right now the "Manual Installation for Chrome on Linux" is a mess to find far down in a listing:

image

I also feel that the twice-repeated call to download is not really a clear call to action and more confusing than it should be:

image

Lastly it should be more clear from the start that the installation takes three steps:

  1. install browser extension
  2. install native message handler
  3. ensure that your jabrefHost.py or .bat is in the proper location

I see from other docs such as https://docs.jabref.org/collect/import that further sub-categories are possible.

So I would like to ask you:

  • Would you be willing to have more sub-pages for this doc page?
  • If yes, should it be sub-categories by operating system or by browser? (I think it should be by browser)

If we get a consensus on these questions I'm happy to contribute a PR.

Thank you!

@koppor
Copy link
Member

koppor commented Mar 13, 2023

Thank you for your interest, and we appreciate the detailed explanation.

  • Would you be willing to have more sub-pages for this doc page?

Yes - this definitively leads to more structure

* **If yes, should it be sub-categories by operating system or by browser?** (I think it should be by browser)

Yes, by browser is fine.

@koppor
Copy link
Member

koppor commented Nov 2, 2023

Refs JabRef/jabref#10308 (comment)

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

2 participants