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

Add "Edit This Page" link to documentation #7293

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Fabs97
Copy link

@Fabs97 Fabs97 commented Nov 18, 2024

This PR closes #7280 by adding a new "Edit this page" link to the markdown page in Github.

To note the requested additions:

  • Add an "Edit this page" button to the bottom of each documentation page
  • Ensure that the button links directly to the Markdown file in the GitHub repository
  • The link should open in edit mode if possible, so users can quickly make changes and propose pull requests
  • The button link should be styled consistently with the rest of the documentation site and be easy to find

Additionally:
The link is currently added to the "Reference" pages only. The logic is handled by the Page.tsx component

Screenshot:
Screenshot 2024-11-18 at 12 58 49

Copy link

vercel bot commented Nov 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
19-react-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 11:59am
react-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 11:59am

@facebook-github-bot
Copy link
Collaborator

Hi @Fabs97!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

Copy link

Size changes

📦 Next.js Bundle Analysis for react-dev

This analysis was generated by the Next.js Bundle Analysis action. 🤖

Five Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/404 105.02 KB (🟡 +260 B) 209.32 KB
/500 105.02 KB (🟡 +260 B) 209.31 KB
/[[...markdownPath]] 106.87 KB (🟡 +260 B) 211.16 KB
/errors 105.23 KB (🟡 +259 B) 209.53 KB
/errors/[errorCode] 105.21 KB (🟡 +259 B) 209.5 KB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 10% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

@harish-sethuraman
Copy link
Collaborator

@rickhanlonii this seems like a good idea? can we confirm if the design is fine? we can implement this if its okay with the team

@hichemfantar
Copy link

hichemfantar commented Nov 20, 2024

@Fabs97 thanks for the pr! can you properly link my issue #7280 by typing closes #7280 instead of solves issue #7280

@hichemfantar
Copy link

hichemfantar commented Nov 20, 2024

i introduced my own attempt #7298 which improves the design by making it match the rest of the website, adding proper spacing, and making it responsive.

The link also fully encompasses the icon and the text.

It also implements correct logic for generating the correct url for the file without fail.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Suggestion]: Add "Edit this page" button to the bottom of each documentation page
5 participants