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

DOC: Update docs to be more user-facing #2853

Merged
merged 2 commits into from
Jul 17, 2023

Conversation

effigies
Copy link
Contributor

This PR does the following:

  1. Reformats the FAQ into a doc site Markdown page: https://effigies.github.io/openneuro/faq.html
  2. Removes GitHub README from index.html content, instead just linking to the repository in the table of contents
  3. Splits TOC into user guide+faq, policies, advanced usage, developer resources.
  4. Removes the policy/index page, which existed only for a TOC we can handle by creating multiple TOCs

Test render here: https://effigies.github.io/openneuro

@nellh nellh merged commit fc11fcb into OpenNeuroOrg:master Jul 17, 2023
2 checks passed
@agt24
Copy link

agt24 commented Jul 17, 2023

This looks great @effigies!

I think this is an improvement on the current version of the documentation, but the navigation is a still a touch confusing as there is some repetition between menu items on the left (on this page) and menu items on the right

There's also significant overlap between content in the landing page ("OpenNeuro Documentation") and the "User Guide".
Both seems to be striving to be an entry point for someone who is looking for help taking different guesses about what info will be most helpful to them. To some extent the FAQ is also trying to be an entry point with different guesses about what to highlight. Ideally the docs would have a single entry point (be it called OpenNeuro Documentation or User Guide) for all users from which they could be re-directed based on their needs (Finding/downloading data, Uploading/sharing data, Advanced topics/developers resources (which seem mergable), and Policy stuff (maybe doesn't need to be top level?),

@agt24
Copy link

agt24 commented Jul 17, 2023

Adding another related point that @effigies and I were discussing on Slack last week. These are all really good docs, but they aren't very prominently linked on the OpenNeuro site (I'd never seen them before last week).

Maybe consider replacing the "FAQ" and "Support" links at the top of the OpenNeuro.org landing page with a single link to "Help" or whatever that then provides the user with options for reading docs, watching video tutorials, or submitting a ticket.

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

3 participants