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.

Sign up for GitHub

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

Jump to bottom

Feat/auto generated docs #32

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

Feat/auto generated docs #32

wants to merge 8 commits into from

Conversation

Odonno
Copy link
Contributor

@Odonno Odonno commented Sep 30, 2023

Auto-generated documentation website.

  • Generated using docfx tool
    • Index page generated from readme.md file
    • API documentation of the project generated from Namespaces, Classes, etc... of the core library (using SurrealDb.Net.csproj)
    • Follows the current website documentation style
  • New GitHub Action workflow = Integrated in the CI to deploy on GitHub Pages
    • Will be updated after each commit (from main branch)
    • Should enable GitHub Pages on this repository for it to work

You can take a look at this preview link: https://odonno.github.io/surrealdb.net/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Odonno