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

Anchors no longer show up on top of side menu #384

Closed
rydmike opened this issue Oct 6, 2024 · 7 comments
Closed

Anchors no longer show up on top of side menu #384

rydmike opened this issue Oct 6, 2024 · 7 comments

Comments

@rydmike
Copy link
Contributor

rydmike commented Oct 6, 2024

Anchors used to show up at the top of the side menu, after recent updates they seem to be gone:

Screenshot 2024-10-06 at 17 13 38

Example usage on https://docs.flexcolorscheme.com/installing and its config https://github.com/rydmike/flex_color_scheme_docs/blob/master/docs.json

@Ehesp
Copy link
Member

Ehesp commented Oct 7, 2024

Ah, "link" should now be "href" to keep consistent with the rest:

https://use.docs.page/configuration#anchors

@rydmike
Copy link
Contributor Author

rydmike commented Oct 9, 2024

Eh and lol, thanks yes that works 😄

Maybe when you break the docs.json config API, consider adding big red info/warning text about it to the docs?

What I experienced now was that the past Anchors feature just appeared to be "gone" without any info anywher. I mean, sure I checked docs, to see that yup Anchors are still there with a title, icons and url. I would never have noticed that you changed "link" syntax to "href".

Sure it was not consistent with the other links, but this is the kind of thing that once you configured it and it works, you don't really bother looking at details like this again. Unless there is a really big warning about it in the doc when you look for explanations on why it is no longer working.

Anyway, thanks for the info, this works. Closing the issue.

@Ehesp
Copy link
Member

Ehesp commented Oct 9, 2024

Similar sentiment here: #394 (comment)

I think in preview mode we need to surface the errors up. In production, maybe throw a console.warn in there with the errors (and document it)?

@rydmike
Copy link
Contributor Author

rydmike commented Oct 10, 2024

Sure why not that too. Doc info about the changed APIs is really easy too 🙂

Generally though, probably just frustration nits in both our cases about when things change and break, and it is not clearly and loudly pointed out. Nothing too serious 😀💙

@Ehesp
Copy link
Member

Ehesp commented Oct 10, 2024

Yep that was my bad - the idea was to automatically migrate old schemas to the new ones, which does work - this just fell apart when people mixed them.

@bizz84
Copy link

bizz84 commented Nov 6, 2024

Just landed here. When was the syntax changed?

@Ehesp not sure if this is only about anchors. Sites such as the old GoRouter documentation are now broken and the sidebar is missing entirely: https://docs.page/csells/go_router

Example of old syntax: https://github.com/csells/go_router/blob/main/docs.json

@Ehesp
Copy link
Member

Ehesp commented Nov 6, 2024

I'll investigate 👍

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