docs: documentation edit links point to the Docusaurus repository

Open Beginner friendly
#48 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
84/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript
Domain
documentation

Research direction

Open website/docusaurus.config.js and inspect the docs editUrl setting first. Update it so generated “Edit this page” links target this project's documentation source, or remove the edit action if the docs are not maintained here. Verify at least one generated docs link points to the intended repository.

Written by the indexing model from the issue text.

Description

What happened

The website configuration in website/docusaurus.config.js sets the docs editUrl to:

https://github.com/facebook/docusaurus/edit/master/website/

The site is for GetStream/react-native-bidirectional-infinite-scroll, so generated “Edit this page” links send contributors to the Docusaurus repository rather than this project's documentation source.

Suggested fix

Point editUrl at the actual source directory in GetStream/react-native-bidirectional-infinite-scroll, or remove the edit action if the documentation is not maintained here. Please verify one generated docs link after updating it.

Dominant language
TypeScript
Stars
269
Forks
24
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from GetStream/react-native-bidirectional-infinite-scroll

All issues in GetStream/react-native-bidirectional-infinite-scroll

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.