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

Consider adding searchable, wiki-like Troubleshooting page #33

Open
BinToss opened this issue Jan 29, 2024 · 1 comment
Open

Consider adding searchable, wiki-like Troubleshooting page #33

BinToss opened this issue Jan 29, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@BinToss
Copy link
Member

BinToss commented Jan 29, 2024

Currently problems and solutions are scattered among three or more locations: manual upgrade README, halospv3/spv3-known-issues/issues, halospv3/spv3-known-issues/wiki, and the #self-help channel in the Discord.

Write up all the issue and solutions as individual pages, tag them with keywords/phrases for SEO, and share them. Where applicable, their preview embeds will show the issue's key phrase as the Page's name along with a short summary of the issue.
However, they should not be written as blog posts. That would make the blog feed messy.
Instead, a Troubleshooting button should be added to the site's navbar which then presents a wiki-like interface for browsing and searching issues.

@BinToss BinToss added the enhancement New feature or request label Jan 29, 2024
@BinToss
Copy link
Member Author

BinToss commented Jan 29, 2024

This will probably be a two-parter.

  • Add Troubleshooting page; Add one page per issue (solution(s) are added to the respective pages as sections/headers). Troubleshooting page should be accessible from the navbar. It should have a page index.
  • may require an additional Jekyll plugin for search functionality. Allow searching by page title, key phrase, keyword(s). Needs search syntax!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant