Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Architecture NavigatorRead The Docs

Technologies used include:

  • php
  • html
  • javascript
  • json
  • css

Technologies used;

  • Python
  • Sphinx
  • reStructuredText
Works on the browserWorks on the browser
Does not create documentationCreates documentation
Offers interractive presentation layer
Content is dynamically loaded as the user navigates to new pages.
Offers quick access to documentation in a click.Documentation is scattered and does not offer a straightforward way of looking up information.
Have embedded backlinks to the wiki.Holds complete and formal technical documentation.
Clickable maps in the form of images.Clickable maps in the form of an SVG diagram.
Dynamic code generation
Allow toggling on and off for some features on demand

INFRASTRUCTURE REQUIREMENTS


ArchNavRead The Docs
Operating SystemGNU/Linux
Web-serverApache
vCPU coresCores2
Memory8 Gb
Storage1 Gb

MAINTENANCE

ArchNavRead The Docs
Requires user training on how to use the toolStraight forward
Will require a team of technical code contributors/committers 
Require manual update of the links to point to the current documentation
Has too many moving parts

...

ArchNav brings complexity when designing a clickable image for the Architecture Nav, the process is a tedious one since you'll have to take a snapshot of the existing diagrams bitmaps, cconvert convert it to a PNG file, draw shapes around objects on the image to generate coordinates and lastly store the image attributes in a JSON object. This is time-consuming compared to creating OVERLAYS using SVG diagrams.

...

Documentation residing in the read the docs is always up to date and the most current. The Arch Nav will require a manual update of the links pointing to the documentation when there is an update making it a repetitive and tedious task.

...