cypress-documentation icon indicating copy to clipboard operation
cypress-documentation copied to clipboard

Component Testing: "What to read next" links

Open marktnoonan opened this issue 2 years ago • 2 comments

Subject

Component Testing

Description

In order to make the Component Testing docs work better as an introduction, we should make sure that at the bottom of each subsection we provide links to the next content that a person should check. This can help make the docs readable in a logically organized way and call attention to sections like the "Styling Components" page that are currently only really accessible through the navigation.

I'm personally inclined to follow links like these when browsing through docs and getting acquainted with a new tool.

marktnoonan avatar Apr 11 '23 13:04 marktnoonan

If you are thinking of having links to additional reading, I think that is fine.

Something that we had in the Beta docs where "Next" and "Prev" links at the bottom of each guide. Feedback gathered was this was awkward as the pages in the section weren't necessarily in a linear order, and no other parts of the docs did this.

elylucas avatar Apr 11 '23 17:04 elylucas

This good to know. I agree a "Further reading" format is probably better than next/previous. Next/previous works great if the docs are conceived that way (eg, Vuetify). But here we not only have a non-linear structure the "next" step is going to sometimes be a fork based on framework. More like "you are ready for these things that might be relevant, you don't have to decide on your own".

marktnoonan avatar Apr 11 '23 17:04 marktnoonan