Giter Site home page Giter Site logo

In content shortcuts anchors broken about docs HOT 7 OPEN

damsfx avatar damsfx commented on August 11, 2024
In content shortcuts anchors broken

from docs.

Comments (7)

LukeTowers avatar LukeTowers commented on August 11, 2024 1

@bennothommo ping

from docs.

LukeTowers avatar LukeTowers commented on August 11, 2024

Can we just manually update them for now on the develop branch?

from docs.

damsfx avatar damsfx commented on August 11, 2024

@LukeTowers Is somebody working on this?
This drive me crazy ...

from docs.

LukeTowers avatar LukeTowers commented on August 11, 2024

@damsfx the helpers page appears to be fixed now, do you want to submit a PR for the other ones?

from docs.

bennothommo avatar bennothommo commented on August 11, 2024

@LukeTowers I was going to fix the validation and collection ones at the same time, the problem though was that anchoring the rules/commands in those pages results in every validation rule / collection method appearing in the Table of Contents (anchors must be a H2 or H3). I wasn't sure if that was gonna be acceptable or not, so I left it.

from docs.

damsfx avatar damsfx commented on August 11, 2024

@LukeTowers I wanted to do it ... but I'm having trouble setting up the documentation locally to test my changes.
Can you or @bennothommo give me some pointers on how to get a working copy of the local documentation?
I alaways fall back in a Failed to open directory: No such file or directory error.

@bennothommo I had the same thought as you when I looked at the documentation plugin code.
I even wondered whether it wouldn't be preferable for these pages to have their own title anchors in a H4 heading rather than polluting the TOC.
But in this case it result in a markdown content having HTML.

from docs.

LukeTowers avatar LukeTowers commented on August 11, 2024

@bennothommo @damsfx I'm fine with the TOC being made bigger on those pages, eventually we'll reorganize the docs to have more pages with less content on each page so it's easier to find information by browsing around, but for now having them in the TOC should be fine. If necessary it would be nice if they could be collapsible, but that's not a hard requirement.

from docs.

Related Issues (18)

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.