Adding a Navigation lacking preview

[mikehansonn]

Please verify the following:

• This issue is related to the Virtual Interns First Steps document or Planet User Manual.
• You have searched for relevant keywords in recent open and closed issues to avoid duplicates.

URL to the MDwiki page containing the problem

https://dynalon.github.io/mdwiki/#!././quickstart.md#Adding_a_navigation

Problem

Most other parts of the MDwiki quickstart docs contain previews of what the feature presented will look like. In the "Adding a Navigation" section, that part is lacking.

Screenshots (when necessary)

No response

Proposed solution(s)

Add a "Will render as:" section to "Adding a Navigation" to be more consistent with other sections like creating links and images.

[Saby-Bishops]

Hi @mikehansonn ,

This is an excellent find! Improving documentation consistency makes it much easier for new contributors (like myself) to understand how things work.

I took a look at the MDwiki quickstart guide you linked, and you are absolutely right. Sections like "Creating links," "Images," and "Syntax highlighting" all have clear "Will render as:" examples, but the "Adding a navigation" section only shows the raw Markdown code.

Adding a visual preview of what the navigation bar will actually look like would be a huge improvement and would make that section much more intuitive. Your proposed solution is spot on.

Thanks for working to make the docs better! Good luck with the fix.