unexpected icon indicating copy to clipboard operation
unexpected copied to clipboard

[website] Make top-level menu URLs

Open plroebuck opened this issue 6 years ago • 3 comments

Make the 'Assertions' top-level URL bookmarkable. http://unexpected.js.org/assertions/ doesn't exist; menu button click autoroutes to http://unexpected.js.org/assertions/any/to-be/.

Make the 'API' top-level URL bookmarkable. http://unexpected.js.org/api/ doesn't exist; menu button click autoroutes to http://unexpected.js.org/api/addAssertion/.

Inconsistent with 'Plugins', which does exist, though its sections lack anchors and cannot be jumped to directly (e.g., http://unexpected.js.org/plugins/#install)

plroebuck avatar May 02 '18 14:05 plroebuck

http://unexpected.js.org/assertions/ doesn't currently exists, what should be on that url?

sunesimonsen avatar May 02 '18 15:05 sunesimonsen

Any generic "index.html" that includes the left-hand list of all possibles. Right-hand content for Assertions page might contain generalities and a list of the assertion groups. Right-hand content for API page could give generic concepts, overalls thoughts, and example usage.

This logic should probably also be applied to each of the assertion groupings as well; these could have right-hand content explaining anything that was common to the grouping.

plroebuck avatar May 02 '18 17:05 plroebuck

I’ve had a quick look at this - it requires patching the documentation generator (partially done) to allow an assertions.md file to override the generated menu option plus retain a sidemenu listing down the left - then a file being added with something to the docs directory in core.

alexjeffburke avatar Dec 11 '19 21:12 alexjeffburke