ninadmhatre / byteguide

Solution for hosting your HTML code docs (fork of hostthedocs)
Other
1 stars 2 forks source link

UX Requirement #1

Closed ninadmhatre closed 10 months ago

ninadmhatre commented 1 year ago

Currently hostthedocs comes with very simple UI. ByteDocs needs to implement

  1. Landing page of product
    • Big Banner with name
    • List of Features
    • Menu with
      • Docs
      • Tutorial
  2. ByteGuide As Product -> Home/Landing page of installed product [what user will see once product is hosted on internal server]
    • -> Banner
    • -> Search box
    • -> Other stats -> Browse (user should be able to browse all projects hosted on current instance)
    • -> How this will be displayed? blocks / list with description?
    • -> Sort by required:[a-z, z-a], [least prio: latest first, oldest first]
    • -> filter by "search string" or by language

Use Case:

As a company, I would like to host code documentation at centralized place within organization. Lets say, There are projects written in Team A: C++, Team B: Java, Team C: C# Team D: Python.

All these projects have autogenerated docs, which can be converted in HTML pages. And then pushed to http://docs.mycomany/

Once, user visits above site in browser,

ninadmhatre commented 10 months ago

with version 0.1.1 all of the above requirements are completed