Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

.NET SDK doc revamp #654

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Odonno
Copy link
Contributor

@Odonno Odonno commented Jul 10, 2024

Improve .NET SDK docs by following the changes made in the JS SDK.

  • Add links to example projects
  • Add Data Types and Getting started pages
  • Split existing doc into My first project, Connection Strings and Dependency Injection pages
  • Split SDK methods into each category
  • Minor tweaks to make the JS and .NET SDK similar cc. @kearfy
    • Reorder data types table to put Native types first
    • Switch Data querying and Live Queries category position, as querying should logically come before LQ
    • Fix typos
  • Improve Live Queries documentation page

The new categories:

image

Copy link

netlify bot commented Jul 10, 2024

👷 Deploy request for surrealdb-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 07f0c3f

@Odonno Odonno force-pushed the feat/dotnet-sdk-updated-docs branch from b886f8e to e9db817 Compare July 10, 2024 11:36
@Odonno
Copy link
Contributor Author

Odonno commented Jul 10, 2024

After another review, I still have a question as to why the info method is in Initialization. I have the feeling that it should be placed in Authentication section.

@Odonno Odonno force-pushed the feat/dotnet-sdk-updated-docs branch from e9db817 to c62571a Compare July 12, 2024 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants