Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

In content shortcuts anchors broken #162

Open
damsfx opened this issue Oct 13, 2023 · 7 comments
Open

In content shortcuts anchors broken #162

damsfx opened this issue Oct 13, 2023 · 7 comments

Comments

@damsfx
Copy link
Contributor

damsfx commented Oct 13, 2023

On some docs pages, in text columned-list shortcuts don't work.
The three pages where I find the issue for now :

https://wintercms.com/docs/v1.2/docs/services/helpers top shortcuts
https://wintercms.com/docs/v1.2/docs/services/validation#available-validation-rules
https://wintercms.com/docs/v1.2/docs/services/collections#available-methods

For the Helpers top shortcuts, anchors need to be updated to remove "_".

For Validation (available validation rules) and Collections (available methods), the corresponding anchors doesn't exists in the rendered page.

@LukeTowers
Copy link
Member

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

@damsfx
Copy link
Contributor Author

damsfx commented Jun 4, 2024

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

@LukeTowers
Copy link
Member

@bennothommo ping

@LukeTowers
Copy link
Member

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

@bennothommo
Copy link
Member

@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.

@damsfx
Copy link
Contributor Author

damsfx commented Jul 31, 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.

@LukeTowers
Copy link
Member

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants