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

feat: add EditPage component for editing documentation pages #7298

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

Conversation

hichemfantar
Copy link

@hichemfantar hichemfantar commented Nov 20, 2024

Introduce the EditPage component to enable users to edit documentation pages directly from the interface. This addition enhances the user experience by providing a clear link to edit content on GitHub.

the design matches 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.

Completed Tasks:

  • 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 should be styled consistently with the rest of the documentation site and be easy to find.

closes #7280

Desktop:
image

Large Desktop:
image

Mobile:
image

Copy link

vercel bot commented Nov 20, 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 Dec 16, 2024 5:15pm
react-dev ✅ Ready (Inspect) Visit Preview Dec 16, 2024 5:15pm

Copy link

github-actions bot commented Nov 20, 2024

Size changes

📦 Next.js Bundle Analysis for react-dev

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

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 104.39 KB (🟡 +7 B)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

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

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

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 106.23 KB (🟡 +267 B) 210.62 KB
/500 106.22 KB (🟡 +267 B) 210.61 KB
/[[...markdownPath]] 108.01 KB (🟡 +265 B) 212.4 KB
/errors 106.44 KB (🟡 +267 B) 210.82 KB
/errors/[errorCode] 106.42 KB (🟡 +265 B) 210.8 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.

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
2 participants