RaythaHQ / raytha

Raytha is a powerful CMS with an easy-to-use interface and fast performance. It offers custom content types, a template engine, and various access controls. It supports multiple storage providers and an automatically generated REST API. Upgrade your development workflow with Raytha.
MIT License
155 stars 30 forks source link

Setup DocFx and Getting Started docs #77

Closed apexdodge closed 1 year ago

apexdodge commented 1 year ago

Did some rudimentary testing with DocFX and it was easy to get started.

https://dotnet.github.io/docfx/index.html

I ran it on the Raytha.Application project and it did a thorough job of picking up literally everything.

image

Need to learn how to properly format and clean it up.

Ideally, the left side navigation is simply:

...etc, etc, basically just the business layer actions, nicely organized.

I created a branch called docfx

apexdodge commented 1 year ago

DocFx is kind of difficult to work with, but I solved the main challenge I was going for:

image

Remaining tasks:

apexdodge commented 1 year ago

Got it working with github actions that builds and deploys the static site to a gh-pages branch and also custom domain:

https://docs.raytha.com/index.html

Still need to add getting started and other pages.

apexdodge commented 1 year ago

Good progress on docs.

Remaining articles:

apexdodge commented 1 year ago

To be released with v1.0.4