search

unexpectedjs / unexpected

Unexpected - the extensible BDD assertion toolkit
http://unexpected.js.org/
MIT License
371 stars 29 forks source link

[website] Make top-level menu URLs #462

Open plroebuck opened 6 years ago

plroebuck commented 6 years ago

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)

sunesimonsen commented 6 years ago

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

plroebuck commented 6 years ago

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.

alexjeffburke commented 4 years ago

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.