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

Wiki improvements #819

Open
juhoinkinen opened this issue Nov 21, 2024 · 0 comments
Open

Wiki improvements #819

juhoinkinen opened this issue Nov 21, 2024 · 0 comments

Comments

@juhoinkinen
Copy link
Member

juhoinkinen commented Nov 21, 2024

I list here some ideas that could make Annif wiki better (to be continued):

  • Add alerts for important points (like "Caution annif download command has a --trust-repo option..." in here).
  • Add links pointing to next/previous page and home to the footer of pages (this would make browsing the Wiki easier).
    • The order of pages should be reviewed before this.
  • More detailed and easier-to-follow instructions for setting up Annif, choosing backends, configuring, training and evaluating projects, and optimizing hyperparameters etc.
    • Now this information is somewhat scattered in Getting Started and Achieving Good Results and other pages.
    • A flowchart would be nice, but textual form is easier to update.
    • A table, which shows the scores typically reachable by different backends, and by different amounts of training data (get an image from the last slides set of Annif tutorial?)
  • Create a FAQ page.
    • Skim through Annif users forum for the FAQs.
  • Improve interlinking with Annif tutorial (how?).
  • Feed whole Wiki to some LLM and prompt for improvements :)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant