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 80.53%. Comparing base (45a6bcb) to head (09a18b4).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #28   +/-   ##
=======================================
  Coverage   80.53%   80.53%           
=======================================
  Files          51       51           
  Lines         966      966           
  Branches       92       92           
=======================================
  Hits          778      778           
  Misses        160      160           
  Partials       28       28           

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[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.

[rickdotnet]

More like, I get busy and forget I had a PR sitting for days.

Only a few days... 😂

@mtmk this should be close to ready. I just rebased it and added the workflow files.

Not sure what that macos-latest error is about.