clearlydefined / clearlydefined/clearlydefined

docs: edit-page links point to view-only tree URL

Open Beginner friendly
#254 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
109
Forks
57
Avg merge
5m
Merged PRs (30d)
1

Description

## What happened
The Docusaurus docs configuration sets the docs edit URL to:

https://github.com/clearlydefined/clearlydefined/tree/main/

in docusaurus.config.js. The blog edit URL is also a repository URL without the edit path.

Docusaurus uses editUrl as the base for the generated “Edit this page” links, so this configuration produces links under GitHub''s tree view rather than the edit view.

## Why it matters
A reader who clicks “Edit this page” is taken to a read-only repository browsing page and cannot immediately propose a documentation change.

## Suggested fix
Use the edit form as the base URL, for example:

https://github.com/clearlydefined/clearlydefined/edit/main/

or remove the edit links if they are not intended to be offered. Please verify one generated docs link and one blog link after the change.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open docusaurus.config.js and inspect the docs and blog editUrl settings. Change the repository base to the edit path, then verify one generated docs link and one blog link open GitHub’s edit view rather than the tree view.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
92/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.