-
Notifications
You must be signed in to change notification settings - Fork 32
Add "Contribute to the docs" link to sidebar and fix "View as Markdown" capitalization #2082
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
Conversation
|
@copilot Forgot to mention. The new link should point to https://www.elastic.co/docs/contribute-docs/ and open in a new window. |
Co-authored-by: theletterf <[email protected]>
Co-authored-by: theletterf <[email protected]>
Co-authored-by: theletterf <[email protected]>
Co-authored-by: theletterf <[email protected]>
Co-authored-by: theletterf <[email protected]>
Done! Updated the link to point to https://www.elastic.co/docs/contribute-docs/ and added |
🔍 Preview links for changed docs |
|
🚀 looking good…all we're missing now is an icon |
|
@copilot Look at the result:
Could the new link be a tad smaller and aligned so that it starts when the text of Edit this page start? Without an icon. |
Co-authored-by: theletterf <[email protected]>
... Done! Made the link smaller ( |
|
@copilot I still want the new text to be indented as if there was an icon, without adding an icon. |
|
Adding a new item here has some implications for the responsive design. Related change: #1399 |
|
@reakaleek Yep! Try it out, I asked Copilot explicitly to hide the new item when the viewport is not wide enough. |
Co-authored-by: theletterf <[email protected]>
Fixed! Moved the |
|
@copilot Great! Two more changes:
|
Co-authored-by: theletterf <[email protected]>
Done! Made both changes:
Commit hash will be updated after push. |
|
@leemthompo Looks neat now!
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Output LGTM 👍
|
Hmmm... as a reader I might think that "Edit this page" is the way to contribute to the docs so then "Contribute to the docs" seems redundant. Thoughts on adjusting it to be more like @florent-leborgne's suggestion in the Slack thread?
|
I agree it's not perfect, but once you click the difference is pretty clear. I found that the first draft made it look like a tacked-on afterthought. @colleenmcginnis would saying "Learn how to contribute" (per #2082 (comment)) assuage this concern? If we could afford the time to make it (a) clean but also (b) visually distinct from the other 3, that would be ideal of course. |
|
Although I guess another approach here would be to link to the syntax guide instead. That's probably what the majority of folks would want if they actually are seeking to edit the page 🤔. |
Is there a deadline we need to meet?
That makes more sense right now since the only detailed docs in |
|
I enjoy this dialectical back and forth — it's for the greater good. :-D Current status:
The link goes to the V3 docs: https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/ We can roll it out now and then change it later once those docs are ported over by the team. |
|
I think it's great to finally make this link super visible on every docs page, we didn't have a great way of surfacing the contribution/syntax guides before this. So I'm happy to merge this latest iteration + the re-rewording to make it clear this links to "Learning" stuff. We could iterate on the UX in the future if we deem the fourth item visually confusing. I've already approved, I'll let anyone feeling strongly against this request changes at this point. |





✅ Implementation Complete
All requirements from the issue have been successfully implemented following the mockup as closely as possible.
Changes Made
Files Modified
src/Elastic.Markdown/Layout/_TableOfContents.cshtmltarget="_blank"to open in new windowhttps://www.elastic.co/docs/contribute-docs/text-sm) like other action linksfill="currentColor"to match other icon colorsdocs/contribute/on-the-web.md.gitignore_static/to prevent build artifacts from being committedLink Order (Desktop View)
Implementation Details
The new link:
https://www.elastic.co/docs/contribute-docs/(absolute URL)target="_blank"text-sm) like other action linksfill="currentColor"for visual consistency with other iconshidden lg:blockclasses for responsive behavior (hidden on mobile, visible on desktop)Code Quality
✅ Passes
dotnet format --verify-no-changes✅ Follows existing Razor template patterns
✅ Consistent with repository conventions
✅ Minimal, surgical changes only
The implementation is ready for review and testing in CI/CD.
Fixes #2056
Original prompt
Fixes #2056
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.