Skip to content

docs: add anchor links to feature sections in README for easy referencing#743

Merged
tchaton merged 10 commits into
Lightning-AI:mainfrom
VijayVignesh1:docs/add_anchor_links
Nov 3, 2025
Merged

docs: add anchor links to feature sections in README for easy referencing#743
tchaton merged 10 commits into
Lightning-AI:mainfrom
VijayVignesh1:docs/add_anchor_links

Conversation

@VijayVignesh1
Copy link
Copy Markdown
Contributor

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?

What does this PR do?

Fixes #742

PR review

Added key features submodules as headers to enable permalinks.

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

@VijayVignesh1
Copy link
Copy Markdown
Contributor Author

VijayVignesh1 commented Oct 30, 2025

@deependujha I've added the submodules as headers to enable permalink. We cannot attach permalinks directly to <details> or <summary> blocks.

@deependujha
Copy link
Copy Markdown
Collaborator

Hi @VijayVignesh1,

The repetitive "Click to expand" phrasing feels a bit clunky and detracts from the overall elegance. What do you think about this cleaner alternative, which embeds a subtle permalink icon directly in the summary?

<details>
  <summary> ✅ <a name="my-custom-anchor"></a> Transform datasets while Streaming <a href="#my-custom-anchor">🔗</a> </summary>
&nbsp;

....

</details>
  • Adds a simple, invisible anchor (<a name="slug"></a>).
  • At end, add a chain icon (🔗) linked to it via <a href="#slug">.

What do you think about this?

cc: @tchaton @bhimrazy

@bhimrazy
Copy link
Copy Markdown
Collaborator

What do you think about this?

yes @deependujha, this looks good — could be a nice addition for navigation.

@VijayVignesh1
Copy link
Copy Markdown
Contributor Author

@deependujha @bhimrazy Done! I was thinking more in terms of hover permalinks, but this one looks compact.

@VijayVignesh1 VijayVignesh1 marked this pull request as ready for review October 31, 2025 14:11
@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 31, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80%. Comparing base (a249a28) to head (a17cb01).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@         Coverage Diff         @@
##           main   #743   +/-   ##
===================================
  Coverage    80%    80%           
===================================
  Files        52     52           
  Lines      7331   7331           
===================================
  Hits       5873   5873           
  Misses     1458   1458           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread README.md Outdated
Copy link
Copy Markdown
Collaborator

@deependujha deependujha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great to me. Feature can be verified in the pr branch.

Copy link
Copy Markdown
Collaborator

@bhimrazy bhimrazy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM too — let’s see what @tchaton says.

@bhimrazy bhimrazy changed the title Docs/add anchor links docs: add anchor links to feature sections in README for easy referencing Nov 3, 2025
@tchaton tchaton merged commit e2135bc into Lightning-AI:main Nov 3, 2025
36 checks passed
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.

README: Add linkable section anchors for collapsible documentation sections

4 participants