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

[website] Make top-level menu URLs #462

Open
plroebuck opened this issue May 2, 2018 · 3 comments
Open

[website] Make top-level menu URLs #462

plroebuck opened this issue May 2, 2018 · 3 comments

Comments

@plroebuck
Copy link

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
Copy link
Member

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

@plroebuck
Copy link
Author

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
Copy link
Member

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.

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

No branches or pull requests

3 participants