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

Move content into the manual #39

Open
dae opened this issue Oct 26, 2024 · 2 comments
Open

Move content into the manual #39

dae opened this issue Oct 26, 2024 · 2 comments

Comments

@dae
Copy link
Member

dae commented Oct 26, 2024

A lot of the content in the FAQs would be better placed in the appropriate section of the manual. The main reason it's on a separate page at the moment is that it was easier to link specific sections when the old manual was all shown on a single page.

Because there are a lot of links to the FAQ pages floating around, we'll probably want to keep the entries here as well, so users don't get a 404.

@joshdavham
Copy link
Contributor

joshdavham commented Oct 26, 2024

What do you think about the idea of winding down the faqs subdomain completely in favour of a unified manual, and temporarily keeping the faqs only for redirects to the manual? Speaking as a user who had to navigate between the two subdomains and found it pretty confusing, I think I'd prefer to just get redirected than to have to remember that there are two different sites that I need to reference when I have questions.

Also, regarding Issues I find with the current faqs, would you prefer I place them here or in the manual repo? (I'm not sure what the timeline would be for moving the faqs to the manual)

@Danika-Dakika
Copy link
Collaborator

What do you think about the idea of winding down the faqs subdomain completely in favour of a unified manual

I'd vote "no" on that. We will need a FAQ as long as there are questions that get asked frequently. 😉 For instance, it's the right place for step-by-step directions -- which really don't belong in the manual -- and for items that need to synthesize multiple areas of the manual. We also don't need to make the manual significantly longer because it doesn't do any good to document things if we can't get folks to read it! 😇 A great thing about a FAQ page is it is short, so it has a lower intimidation factor for the documentation-averse.

I'm all-in for innovation though. There's still a lot of updating and streamlining that could be done on both the manual and FAQ!

Also, regarding Issues I find with the current faqs, would you prefer I place them here or in the manual repo?

We launched anki-manual Issues just a few months ago (which has been excellent!) with the plan that we'd document everything there at first, and see whether a separate Issues was necessary for the faqs repo. So there are a number of FAQ-specific issues already opened over there.

How about this?

  • If it's an update needed in the FAQ, or a suggested addition / removal of a FAQ page --> faqs repo.
  • If it's about overall terminology, or changes that are needed in both places --> anki-manual repo.
  • If it's about merging something from the FAQ into the manual (and deprecating a FAQ page) --> hmmm... anki-manual repo probably, since that's where the change will be most obvious?

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

3 participants