Skip to content

docs: remove duplicate usage link and restore [^4] footnote reference in README#466

Open
ameyypawar wants to merge 2 commits into
supervc-stack:mainfrom
ameyypawar:docs/fix-readme-usage-links
Open

docs: remove duplicate usage link and restore [^4] footnote reference in README#466
ameyypawar wants to merge 2 commits into
supervc-stack:mainfrom
ameyypawar:docs/fix-readme-usage-links

Conversation

@ameyypawar

Copy link
Copy Markdown

What

Two small README.md fixes (docs-only, no functional change):

  1. Removed a duplicate usage link. The "For more usage, please read:" list contained Quantization Types twice — identical text and URL:

    - [Quantization Types](https://docs.vectorchord.ai/vectorchord/usage/quantization-types.html)
    - [Graph Index](https://docs.vectorchord.ai/vectorchord/usage/graph-index.html)
    - [Quantization Types](https://docs.vectorchord.ai/vectorchord/usage/quantization-types.html)   <-- removed
    
  2. Restored the orphaned [^4] footnote. [^4] is defined but never referenced inline, so its blog/doc links don't render. Every other footnote ([^1], [^2], [^3], [^5]) has an inline marker, so this adds [^4] to the Accelerated Index Build bullet — on the "hierarchical K-means" clause, matching the footnote's own #hierarchical-k-means anchors:

    ...Powered by hierarchical K-means[^4] and highly optimized disk operations...
    

Happy to relocate the [^4] marker (e.g. onto the "20 minutes" claim instead) if you prefer a different anchor.

… in README

The "For more usage" list had "Quantization Types" twice (identical text and
URL); remove the duplicate. Footnote [^4] was defined but never referenced, so
its blog/doc links never rendered; attach the marker to the "Accelerated Index
Build" claim it documents (100M vectors in 20 minutes via hierarchical K-means).
The footnote's links both anchor on #hierarchical-k-means, so place the
inline marker on that clause (mirroring how [^5] sits on "sampling"),
rather than on the "20 minutes" claim.
@github-actions

Copy link
Copy Markdown


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

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

Successfully merging this pull request may close these issues.

1 participant