[WIP] Refactor the navbar

[plaindocs]

This is a WIP take on #41 that looks something like:

• Cucumber
  • Overview
  • 10 min Tutorials
  • Installation
  • Running Cucumber
  • Gherkin Reference

• Guides

  • Best Practices (content/best-practices.md)
  • content/browser-automation.md
  • content/testable-architecture.md
  • continuous-integration.md
  • mocking-and-stubbing-with-cucumber.md

• BDD

  • Overview
  • BDD Tutorial
  • Example mapping
  • Who does What

• Support
  • get-in-touch.md
  • contributing.md
  • contributing-to-documentation.md
  • content/voting.md

Main issues not covered so far are:

• About (links to blogs, etc). Not very important.
• How to cater list implementations. I'd tend to list these on the landing page, and / or at the end of running.md
• Many remaining Cucumber topics. Within reason these can be added to the Cucumber menu as they are now.
• Where does the intro to TDD fit? And a couple more odd balls.

• As the entire Nav is now driven by TOML config, some cleanup is needed in removing :menu: head matter from all files.
• Landing pages - most important is the main docs landing page.
• A limitation of this Nav bar is that if you link to a page such as the Cuke Overview, or BDD Intro, there is no connection to the rest of that 'Group'. Unless we have some kind of JS to keep the relevant Drop down open, but that doesn't really work because it covers page content.

[plaindocs]

Addressing a few issues from issue 41:

• The guides definitely belong here, the docs are more than just reference. I think even the BDD Guides belong here, although that is less clear cut, and it could be argued thatthey are more background information. But remember we might get expert developers who are new to BDD and expert BDD practitioners who are new to coding...

• Contact-us is always useful, unless you don't actually want people to :-p

[plaindocs]

Well that was fun.

[mlvandijk]

Overall, I like where this is going!

• Agree on having contact options, but don't want to duplicate "Support" page..
• Agree on having Guides and BDD info

Several suggestions:

1. Add "Cucumber reference" in addition to Gherkin reference (the in depth documentation mentioned by @mpkorstanje )
   Should contain Step Definitions, Hooks and Tags.
   Could also contain: Background, Scenario Outlines, Step Arguments, Doc Strings, Data Tables, and possibly Running and Configuring.

2. cucumber.yml should be part of / linked in Configuration?

3. Voting opens a popup atm. Is that what we want?

4. Fix link to /implementations/ properly (I've commented out the /implementations/ link in documentation.md for now just to get it to deploy)

5. Add a bit more text in the documentation.md? I do like providing some direct links here!

6. Link from the Intro to Gherkin reference and Cucumber reference (see 1)?

7. We should check the subtitles for menu items once we get the structure right. (Note: Mocking & stubbing subtitle was incorrect => fixed)

8. Possibly rename the "Guides" to "Best Practices" and list them by topic?
   "Guides" to me implies more of a how to (Tutorials).
   Also, split "Best practices" and "Antipatterns" (like before)

[plaindocs]

Addressing @mlvandijk 's points

• contact / support I don't feel strongly about
• Cucumber reference also makes sense, I've put it in and taken it out a few times :-D
• config/yaml sure, Although I I think that Config files doesn't add much, so I'll merge it with running. The topics need linking for sure
• voting pop up I'll pass along to @aslakhellesoy
• We need intros to most stuff, but doesn't really make sense to write them without knowing structure
• ditto subtitles
• Also kinda agree on Best Practices vs Guides, but it is a bit of a mixed bag.

[Edits]

[mlvandijk]

Updated the following:
Ad 1. Added a Cucumber reference to first menu (containing step-definitions.md, hooks.md and tags.md, running.md and configuration.md)
Note: I have not yet deleted the original step-definitions.md, hooks.md, tags.md, running.md and configuration.md, because then I'd have to also update links everywhere. I'll do it, if "Cucumber Reference" is ok like this.

Ad 2. Remove Cucumber.yml from menu
There is a link to Cucumber.yml from Configuring.
Also we should still check / update the text for cucumber.yml.md as well as the docs it links to (see #25).

Cucumber:

• Overview
• 10 min Tutorials
• Installation
• Gherkin Reference
• Cucumber Reference

9. I think "Installation" should be merged into the 10 min tutorial. Note: this would mean that the link on landing page to "Install" should change. I'd suggest it to go to "Get started" (i.e. the 10 min tutorial).

10. I've updated the Guides menu. I'm not happy yet with the order of items and also think it might be a bit to heavy compared to the other menu's. Feedback welcome :)

Also, I've added Blog Posts, Related Tools and Projects to Support menu. Maybe they should be part of a separate menu, but this works too for now.

The BDD menu I'm happy atm.

[mlvandijk]

Hi @aslakhellesoy Since you merged this PR, can I assume you are happy with the structure so far? (If so, I need to delete the separate docs I've combined into "Cucumber reference" for instance, and fix all the links to those topics. I should be able to do so today/tomorrow.

[aslakhellesoy]

Yes @mlvandijk looks great! I've set aside all week (except Wed) to work on docs, so expect a lot of activity from me!