Skip to content

feat: add edit and article request links to the page footer - #957

Open
Gaic4o wants to merge 2 commits into
feature-sliced:mainfrom
Gaic4o:feat/256-article-request
Open

Gaic4o wants to merge 2 commits into
feature-sliced:mainfrom
Gaic4o:feat/256-article-request

Conversation

@Gaic4o

@Gaic4o Gaic4o commented Sep 2, 2026

Copy link
Copy Markdown
Member

Background

I created this PR to address #256.

At first, I considered closing the issue as Not Planned, but I thought it could still be useful to give readers of the official documentation a more approachable way to suggest topics they would like to see covered.

There are already several channels where people can leave feedback, such as Issues, Discussions, and the community, but I thought having an entry point directly within the documentation could make it a bit easier for readers to naturally turn those thoughts into documentation requests.

So I added Edit page and Request an article links to the bottom of documentation pages. Request an article links to the Ideas category in Discussions, where documentation-related ideas are already being shared.

Originally, I wanted to discuss the direction with Solant, who usually reviews these changes, before working on the UI. Since Solant is currently on vacation and the scope of the change is relatively small, I went ahead and put together a quick proposal first. If there is a better way to approach this through Issues or Discussions, I would be happy to discuss it in #256 and adjust the implementation accordingly.

I see this as a small UI addition that provides readers with a slightly easier way to participate in improving the documentation without significantly changing the existing documentation flow.

Request an article and Edit page links in the documentation footer

@Gaic4o
Gaic4o marked this pull request as ready for review September 2, 2026 14:41
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
pr-fsd ✅ Ready (View Log) Visit Preview 62741ac

@Gaic4o
Gaic4o requested a review from Solant September 3, 2026 14:58
Comment thread src/env.d.ts

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We can use the FSD-approved way of doing ambient imports: https://fsd.how/docs/guides/examples/types/#ambient-declaration-files-dts

P.S. I'm not 100% fond of the name like untyped-packages, as it might create very long paths. (Maybe something like “typings” might be enough, but I'm fine with any folder name.)

Edit page
</a>
)}
<a href={requestUrl} class="print:hidden">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

do you think we need target="_blank" there?

!isSplash && (
<>
{editUrl && (
<a href={editUrl} class="print:hidden">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  1. Do you think we need target="_blank" there?
  2. How is it going to work with someone who has no write access to the repository? From what I can see, the button there is to commit directly into master (which even we can't do)

This branch has not been deployed

No deployments
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.

2 participants