openlibhums / openlibhums/memory-alpha

Documentation suggestion box or equivalent

Open
#158 1 comment 0 reactions 1 assignee View on GitHub

@S-Haime is already working on this.

Since Aug 13, 2025.

Dominant language
Markdown
Stars
0
Forks
0
Avg merge
4d 14h
Merged PRs (30d)
2

Description

Is your feature request related to a problem? Please describe.
On the documentation pages at https://janeway.readthedocs.io, there is no obvious way to tell the Janeway team that you can't find the answer to a question you have, so they do not get feedback on the type of documentation improvements that are needed. I couldn't find out how to change the text on the 'Decline to Review' page, e.g., and I don't know whether it's possible to do so or not.

Describe the solution you'd like
Add a prominent link to the left sidebar of the documentation site with something like "Do you have a question that is not answered here? Tell us so we can improve the documentation."

Clicking that link will take users to a form that has four parts.

  1. The user can enter the question they are trying to answer.

  2. The user is prompted to enter the search terms they used to try to find the answer in the current documentation. This has the added benefit of prompting users to actually search the existing documentation before bothering the dev team. Also, if the user doesn't enter any search terms, the page can prompt them to try searching before sending the question via the form.

  3. The user can be given links to the Janeway support forum and GitHub pages with an explanation of when they should look at these resources rather than the documentation.

  4. The form should give the user the option to put in their email and submit their question and get notified when the information is uploaded to the documentation.

Alternately, the form could include just 2 and 3 above, and the user could be prompted to submit their questions through existing resources. The downside is that (I think) they need to make accounts at those places to submit their questions, so feedback will be reduced.

Describe alternatives you've considered
Leave as is and reduce the ability of users to let you know what the documentation is not explaining to them.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.