Solo: Documentation and Design

[georgi-l95]

This EPIC covers work regarding documentation and design.

Documentation

Tasks

Preview Give feedback

1. Documentation: Add home page to showcase the project #406
   Documentation released +2
   
2. Documentation: Navigation Bar preliminary #411
   Documentation released +2
   
3. Documentation: Add Getting Started page #412
   Documentation released +2
   
4. Documentation: Add Contribution category #413
   Documentation P3 +2
5. Documentation: Add FAQ page #640
   P3 +1
6. Documentation: refactor hugo workflow to leverage task for working locally on docs #639
   P1 released +2
   
7. In the README maintain a compatibility matrix for the version of Solo with the version of Hedera, and other technologies. #503
   Documentation P1 +2
   
8. Create design for LocalConfig #656
   5 of 5
   Design P0 +2
   
9. Create design for RemoteConfig #657
   0 of 2
   Design P0 +2
   
10. Create a Solo network diagram to assist users and developers in understanding Solo's infrastructure and processes #691
    P3 Requested by Stakeholder +2
11. Switch from jsdoc to typedoc #699
    0 of 3
    P1 released +2
    
12. Suppress namespace log statement when it is undefined #721
    0 of 1
    Documentation P2 released +3
    
13. Update readme and mark breaking changes #729
    P0 released +2
    
14. Enhance Hugo doc process to handle and preserve multiple versions of past docs (readme and typedoc files) #731
    P2 good first issue candidate hacktoberfest +3
15. Create instructions on how to create expose ports necessary to create an SDK connection to both the Consenus Nodes plus the Mirror Node #816
    0 of 6
    P1 Requested by Stakeholder released +3
    
16. Split current Readme into multiple pages and restructure docs #914
    6 of 7
    Epic Lv2 P2 +2
    
17. Update README that v0.32.0+ only supports hedera v0.58.1+ #1041
    P1 released +2
    
18. docs did not update with patched releases, only when release artifact off of main branch? this might be fine until we add the multi-version PR we listed for first time contributors #1062
    P2 +1
19. images didn't publish with README when deploy release artifact ran for Solo on v0.32.0 #1084
    P2 released released on @0.33.x +3
    
20. the README documentation link does not point to the Hugo pages #1085
    P2 released released on @0.33.x +3