csf-dev/ZPT-Sharp

To determine what needs to be updated, the documentation website should be explored

craigfowler opened this issue · 1 comments

This ticket is to investigate the current documentation website and determine what needs to be updated/refreshed/rewritten in order to get it up to date with v2.x.

Structure of the docs website

This comment is a work-in-progress representing the investigation.

Navigation common to all pages

This should appear in the page header, for example top-right.

  • Documentation home
  • Source code
  • Community
    • Issues
    • Discussions
  • NuGet packages

Home page

  • Brief introduction (good but could be improved)
    • Focus on the 4 use cases, perhaps combine the two MVC ones
  • Should have more attractive graphics than current
  • Sample code should be much shorter, perhaps integrated with graphics
  • Good idea to focus on next steps, although "which" next steps could be revised. A better heading might be Get started
    • Quick-start guides - the four guides:
      • ASP.NET MVC5
      • ASP.NET Core MVC
      • Command-line
      • Consume the API
    • ZPT tutorial - learn the syntax by doing
    • Why ZptSharp? - from a conceptual perspective

Documentation homepage

The documentation home page should primarily act as a gateway to other areas of the documentation.

Get started

These topics are the same as the home page Get Started section.

  • Quick start guides
  • ZPT tutorial
  • Conceptual overview

Reference

  • MVC ViewEngines
  • Consuming the API
  • ZPT Syntax reference
  • The CLI app
  • Compatibility

Contributing & extending

  • Development info
  • Writing extensions
    • Document providers
    • Expression evaluators