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

Where to host the Qi wiki? #139

Open
countvajhula opened this issue Dec 19, 2023 · 0 comments
Open

Where to host the Qi wiki? #139

countvajhula opened this issue Dec 19, 2023 · 0 comments
Labels
developer Relevant only to Qi developers RFC Comments from the community are solicited

Comments

@countvajhula
Copy link
Collaborator

countvajhula commented Dec 19, 2023

Qi's user docs are hosted on the Racket Package Server where they are publicly available and searchable, and that is a fine arrangement.

Qi's wiki is the one-stop shop for developer documentation and community events. But it has several issues today:

  1. It isn't searchable (this is especially needed for searching meeting notes for items that were known to be discussed).
  2. It's not indexed by search engines (due to robots.txt), except in some sneaky way by Bing (see Bing vs Google)!
  3. Using GitHub for source code hosting, collaboration (Git and pull requests), CI (GitHub Actions), Issue tracking (GitHub Issues), backup user documentation (GitHub Pages), and the Wiki (Github Wiki) seems like a rather heavy investment in one provider! It would be more healthy to diversify this.
  4. MarkDown is not nearly expressive enough for a Wiki (e.g. no table of contents! Hyperlinks are all raw URLs!). It would be better to use reStructuredText, Scribble, or something else.

Any ideas?

@countvajhula countvajhula added the developer Relevant only to Qi developers label Dec 19, 2023
@countvajhula countvajhula added the RFC Comments from the community are solicited label Jan 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer Relevant only to Qi developers RFC Comments from the community are solicited
Projects
None yet
Development

No branches or pull requests

1 participant