docs: improve discoverability #1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: schplitt <96245357+schplitt@users.noreply.github.com>
Copilot
AI
changed the title
I have a GitHub project that I want indexed on Google so that it is easier to find. How do I do that?
ChatGPT said:
Nachgedacht für 9s
Great question — you don’t “submit” a GitHub repo to Google directly, but you can make it very easy for Goo...
Improve README for better Google indexing and Web NFC discoverability
Sep 29, 2025
Owner
|
Remove the references to web nfc as this is not yet tested. |
Co-authored-by: schplitt <96245357+schplitt@users.noreply.github.com>
Contributor
Author
Removed all Web NFC references from both README.md and package.json as requested. This includes the Web NFC Browser Integration section, all NDEFReader/NDEFWriter examples, Web NFC documentation links, and the "web-nfc" keyword. The SEO improvements for general NFC/NDEF discoverability have been retained. (d6d5b95) |
Copilot
AI
changed the title
Improve README for better Google indexing and Web NFC discoverability
Improve README for better Google indexing and NFC discoverability
Sep 29, 2025
schplitt
changed the title
schplitt
approved these changes
Sep 29, 2025
schplitt
deleted the
copilot/fix-9494a1e9-20b9-4139-bb6a-7471ae146f51
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enhances the README and package.json to improve the project's discoverability on Google and npm, making it easier for developers to find tsndef when searching for NFC and NDEF solutions.
Changes Made
README Improvements
Enhanced Title & Introduction
Comprehensive FAQ Section
Added frequently asked questions that target common search queries:
Package.json Optimization
Enhanced Keywords
Expanded keywords from 10 to 16 terms, adding search-relevant terms:
javascript,encoder,decoder,parser,uri-record,json,browserSEO Benefits
These changes will improve discoverability for searches like:
The additions maintain all existing documentation while making the project more accessible to developers working with NFC and NDEF technologies.
Original prompt
I have a GitHub project that I want indexed on Google so that it is easier to find. How do I do that?
ChatGPT said:
Nachgedacht für 9s
Great question — you don’t “submit” a GitHub repo to Google directly, but you can make it very easy for Google (and people) to find. Here’s a concise, battle-tested checklist.
Public repo and a clear, human name (e.g., fast-image-resizer > fir).
Fill out the About panel: short description, website, topics (add up to ~20 precise tags).
Add a LICENSE, README, CHANGELOG, CONTRIBUTING. These are crawlable and show maturity.
README SEO basics
Start with an H1 that includes the main keyword (“Fast image resizer in Go”).
First paragraph: a 1–2 sentence plain-language summary with key terms (no stuffing).
Headings for Install, Usage, Examples, FAQ — Google loves structured docs.
Add images with descriptive alt text; avoid text baked into images.
Link to related projects/standards (sensible internal/external links).
Create Releases and Tags; they generate additional pages Google can index.
Add a social preview image (Settings → Social preview) for better link sharing.
A small docs site gives you pages you can verify in Search Console and a place for sitemaps.
Enable GitHub Pages (Settings → Pages) from /docs or root.
Add minimal docs:
docs/index.html
<!doctype html>
<title>Fast Image Resizer for Go</title> <script type="application/ld+json"> { "@context":"https://schema.org", "@type":"SoftwareSourceCode", "name":"Fast Image Resizer", "codeRepository":"https://github.com/you/fast-image-resizer", "programmingLanguage":"Go", "applicationCategory":"DeveloperApplication", "license":"https://opensource.org/licenses/MIT" } </script>Fast Image Resizer for Go
SIMD-accelerated resizer with CLI and library APIs.
View on GitHub
docs/robots.txt
User-agent: *
Allow: /
Sitemap: https://yourdomain.com/sitemap.xml
docs/sitemap.xml
https://yourdomain.com/ https://github.com/you/fast-image-resizer https://github.com/you/fast-image-resizer/releases https://github.com/you/fast-image-resizer#readmeTip: If you can, add a custom domain (e.g., yourdomain.com), set DNS in the repo’s Pages settings, then verify it in Google Search Console and submit the sitemap. You can’t verify github.com/... in Search Console, but you can verify your Pages site (especially with a custom domain).
Link the repo from your personal site, blog posts, docs, and social profiles (GitHub, LinkedIn, X, Reddit).
Publish a launch post (Dev.to/Medium/Hashnode) that links to both the repo and the Pages site.
If applicable, publish to package registries (npm, PyPI, crates.io, Go modules) — their package pages link back.
Add to curated awesome-lists or community directories (when truly relevant).
Use precise topics (e.g., image-processing, go, cli, resizing, simd).
In README, mention synonyms users search for (“thumbnail”, “scaler”, “downsampling”).
Keep a CHANGELOG and Releases; fresh content gets crawled more.
Avoid keyword stuffing, autogenerated junk sections, or thin pages.
Private or recently renamed repos without redirects set.
All content living in screenshots instead of text.
No description/topics or a vague README.
Link schemes or spammy backlinks (can hurt you).
If you want, paste your repo link and I’ll give you a tight, repo-specific SEO pass (README headline, 10 suggested topics, and a ready-to-drop docs/ folder).
You said:
https://github.com/schplitt/tsndef
ChatGPT said:
Nachgedacht für 50s
Nice repo! I looked it over and did a repo-specific SEO pass for tsndef. Below is a drop-in checklist + copy-pasteable snippets so Google (and people) can find it more easily.
Quick wins (5–10 mins)
About panel
Description: “Type-safe TypeScript/JS library to create & parse NFC NDEF messages. Works in browser (Web NFC) and Node.”
Add a website (use GitHub Pages — steps below).
Add topics (paste the list below).
README first screen
Replace your top heading/lede with the SEO-tuned header below.
Tags/Releases
Create a v1.0.x release with a short notes section (Google indexes release pages).
Link to Web NFC docs
Add a “What is NDEF / Web NFC?” section that links to MDN and Chr...
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.