search

PalisadoesFoundation / talawa-docs

Documentation for Talawa and Talawa-API
https://docs.talawa.io/
GNU General Public License v3.0
41 stars 140 forks source link

Fix Talawa-API broken links visible when starting the Talawa-Docs app #821

Closed palisadoes closed 2 months ago

palisadoes commented 2 months ago

Describe the bug When starting Talawa-Docs there are numerous references to broken links in the console. Most, but not all, are related to README.md files

To Reproduce Steps to reproduce the behavior:

  1. Start Talawa-Docs
  2. The console shows broken links

Expected behavior

  1. Start Talawa-Docs
  2. No broken links are discovered in startup.
    1. The end user must get no 404 errors when clicking any link in talawa-docs generated websites
  3. All other web page content is maintained.

Actual behavior

Screenshots

If applicable, add screenshots to help explain your problem.

Additional details

image

Potential internship candidates Please read this if you are planning to apply for a Palisadoes Foundation internship https://github.com/PalisadoesFoundation/talawa/issues/359

Alokih commented 2 months ago

Hey @palisadoes, Can I work on this issue ?

Alokih commented 2 months ago

Hey @palisadoes , @Cioppolo14 Can you help me a little bit , can't I just change onBrokenLinks & onBrokenMarkdownLinks to "ignore" from "warn" in docusaurus.config.js file or do you want me to remove all those warning links ?

palisadoes commented 2 months ago

The user will click on the links and get 404 errors. We can't have that. That's poor UI/UX design. You need to fix the root cause, not hide the issue.

Alokih commented 2 months ago

Hey @palisadoes , I have created a PR , can you please look at it