Giter Club home page Giter Club logo

Comments (6)

MikeMcC399 avatar MikeMcC399 commented on June 8, 2024 1
  • The remaining false positive broken anchor link reports (see above #5630 (comment)) are transferred to a new issue #5720

from cypress-documentation.

jennifer-shehane avatar jennifer-shehane commented on June 8, 2024 1

@MikeMcC399 Thank you! That was a lot of fixes.

from cypress-documentation.

jennifer-shehane avatar jennifer-shehane commented on June 8, 2024

We'd accept a PR to fix this

from cypress-documentation.

MikeMcC399 avatar MikeMcC399 commented on June 8, 2024

@jennifer-shehane

We'd accept a PR to fix this

I'll make a start on this. For ease of reviewing I will submit multiple PRs.

There are also false positives in the list, which will need looking at to see if they can be avoided.

from cypress-documentation.

MikeMcC399 avatar MikeMcC399 commented on June 8, 2024

All broken anchor links have now been fixed. Thanks to @jennifer-shehane for her patience in merging all the related PRs! 🙂 The errors in anchor links had built up over the years and there was no automatic checking in place until Docusaurus added this functionality recently.

The final npm run build log shows only false positive errors.
See https://app.circleci.com/pipelines/github/cypress-io/cypress-documentation/24781/workflows/b04b3717-0762-45f6-9288-dd5b04018435/jobs/62341 > Docs build

> [email protected] prebuild
> rm -rf dist && npm run build:plugins


> [email protected] build:plugins
> npm --prefix ./plugins/cypressRemarkPlugins run build


> [email protected] prebuild
> rm -rf ./dist


> [email protected] build
> tsc


> [email protected] build
> docusaurus build --out-dir dist

[INFO] [en] Creating an optimized production build...
[info] [webpackbar] Compiling Client
[info] [webpackbar] Compiling Server
[success] [webpackbar] Client: Compiled successfully in 1.52m
[success] [webpackbar] Server: Compiled successfully in 1.97m
[INFO] Docusaurus found broken anchors!

Please check the pages of your site in the list below, and make sure you don't reference any anchor that does not exist.
Note: it's possible to ignore broken anchors with the 'onBrokenAnchors' Docusaurus configuration, and let the build pass.

Exhaustive list of all broken anchors found:
- Broken anchor on source page path = /api/cypress-api/custom-commands:
   -> linking to /plugins#custom-commands
- Broken anchor on source page path = /api/cypress-api/custom-queries:
   -> linking to /plugins#custom-commands
- Broken anchor on source page path = /api/table-of-contents:
   -> linking to /plugins#custom-commands
- Broken anchor on source page path = /examples/recipes:
   -> linking to /plugins#authentication
- Broken anchor on source page path = /faq/questions/using-cypress-faq:
   -> linking to /plugins#email
   -> linking to /plugins#preprocessors
- Broken anchor on source page path = /guides/core-concepts/writing-and-organizing-tests:
   -> linking to /plugins#preprocessors
- Broken anchor on source page path = /guides/overview/why-cypress:
   -> linking to /plugins#visual-testing
- Broken anchor on source page path = /guides/references/best-practices:
   -> linking to /plugins#email
- Broken anchor on source page path = /guides/tooling/visual-testing:
   -> linking to /plugins#visual-testing

[SUCCESS] Generated static files in "dist".
[INFO] Use `npm run serve` command to test your build locally.

from cypress-documentation.

MikeMcC399 avatar MikeMcC399 commented on June 8, 2024

@jennifer-shehane

Thank you! That was a lot of fixes.

You're welcome! 🙂

from cypress-documentation.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.