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

Put docs.md somewhere that's indexed by Google #8

Open
simonw opened this issue Jul 30, 2022 · 3 comments
Open

Put docs.md somewhere that's indexed by Google #8

simonw opened this issue Jul 30, 2022 · 3 comments

Comments

@simonw
Copy link

simonw commented Jul 30, 2022

I found out the other day that GitHub blocks access to crawlers to pages in the repo other than the main README - which means https://github.com/asg017/sqlite-lines/blob/main/docs.md is unlikely to be correctly indexed by search engines.

Details here: https://github.com/orgs/community/discussions/20958

A couple of options:

  • Publish the documentation using GitHub pages
  • Move all of the documentation into the README
  • Ignore this because it's not a big deal
@asg017
Copy link
Owner

asg017 commented Jul 30, 2022

Hey thanks for the heads up, I didn't know that!

I definitely want this indexed, in case people lookup SQLITE_LINES_DISABLE_FILESYSTEM or SQLITE_LINES_ENTRYPOINT. Will probably push it to GitHub pages so the README doesn't get too cluttered.

@simonw
Copy link
Author

simonw commented Jun 22, 2023

Another option for the individual plugins like https://pypi.org/project/datasette-sqlite-lines would be to include a copy of a README in the PyPI package, and let PyPI render it.

@asg017
Copy link
Owner

asg017 commented Jun 22, 2023

I'm planning to release individual websites for each extension (including this one) that'll host documentation/examples. I'll also improve individual binding README for the different languages (pypi for python and datasette bindings, npmjs.org READMEs, crates.io, godoc, etc.), but the site will be the main SEO target

The first will be sqlite-vss, but still need some work before "releasing" https://alexgarcia.xyz/sqlite-vss

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

2 participants