Skip to content

Major restructure of the Wiki #660

@Mr-KayZ

Description

@Mr-KayZ

General issue:

  • The wiki is extremely disorganized in terms of headings and categories.
  • Some headings are redundant, others are misleading.
  • The lack of organization leads to some pages being less prominent and less attention than they deserve, people getting confused, etc.

TL;DR - We need to restructure the wiki:

  • Better categorization and heading details
  • Remove redundant pages and sections, or add their parts to other wiki pages
  • Clearer pattern of flow and structure

IMPORTANT NOTES AND ISSUES THIS WILL BRING

  • This will lead to link breaking in factoid usage of both Reddit and Discord, so we will need to clean up those there as well.
  • Some people (especially people in BAPC) outside our community uses the wiki and have bookmarked specific pages, so we may need to create some form of announcement mentioning this change is coming soon too.

The implementation idea probably would be something like this:

  • First create simple categories like "OS installs", "Troubleshooting", etc. - Very vague stuff (Again, this is an idea of implementation, not saying these will be the starting headers)
  • We then can split these into further categories depending on the no. of articles each category has. Like if "Troubleshooting" has 150 pages, maybe we can split that into further classifications?
    • For stuff that doesn't fit in one category or another, maybe have a misc. category too? Again, just spitballing ideas.
  • This will require thorough discussion in the r/techsupport discord probably: https://discord.com/channels/749314018837135390/1071069467955703888
  • Depending on how massive this restructure goes, we may have smaller sub issues and this can be a bigger epic?

Other potential ideas perhaps?

  • Considering we have lots of Linux guides now, maybe have another category in the frontmatter?
    • I.e. OS type in there? Linux/Windows/Mac categories? 🤷
  • Improve callouts for certain pages
    • Some pages have poorly utilized callouts which can lead to confusion or glossing over of important facts. Maybe do some proper cleanup during this procedure too?

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions