Add Base Doc Site

[rickdotnet]

Targets issue #24, this PR aims to add a foundation for future documentation and examples.

Added:

• DocFX-based documentation site
  • Matches the structure of NATS.Net Docs .
  • Run locally or hosted on GitHub Pages.
• DocsExamples project
  • Sits alongside Tests, consistent with NATS.Net docs samples.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.88%. Comparing base (24160d3) to head (1e1c96e).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #28   +/-   ##
=======================================
  Coverage   76.88%   76.88%           
=======================================
  Files          48       48           
  Lines         809      809           
  Branches       63       63           
=======================================
  Hits          622      622           
  Misses        162      162           
  Partials       25       25           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rickdotnet]

Figured I'd start with a PR to introduce docs. This will get us a step closer to having more docs/examples.

If you want to publish to GH Pages, I'd suggest a follow-up PR, but I can add those changes if you want to pull the trigger now.

[mtmk]

Figured I'd start with a PR to introduce docs. This will get us a step closer to having more docs/examples.

it's a great base already. we can start adding more examples gradually

If you want to publish to GH Pages, I'd suggest a follow-up PR, but I can add those changes if you want to pull the trigger now.

it'd be nice to have it on GH pages you can start if you like I can pick up the settings etc. as we go on or leave it to a follow up if you think it's getting too busy in this PR.

[rickdotnet]

it'd be nice to have it on GH pages

Agree, will start on it in this PR, then.

if you think it's getting too busy

More like, I get busy and forget I had a PR sitting for days. 😂 . I should be able to keep on this one, though. Will take it as far as I can and loop you in.