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

Update documentation configuration #86

Merged
merged 12 commits into from
Mar 25, 2025
Merged

Update documentation configuration #86

merged 12 commits into from
Mar 25, 2025

Conversation

localden
Copy link
Collaborator

Making sure that we're able to render API documentation.

Co-authored-by: Eirik Tsarpalis <[email protected]>
Copy link
Contributor

@eiriktsarpalis eiriktsarpalis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a toc.yml so that links to API documentation are listed more prominently on the website.

@eiriktsarpalis
Copy link
Contributor

I've pushed a few changes updating the landing page and making a few amendments to the assets. Here's what the generated page looks like now (using dark mode):

image

And using light mode

image

I've added a Makefile for automating the generation steps. You can check the results locally using make serve-docs from the command line.

@eiriktsarpalis
Copy link
Contributor

Here is the deployed page in my repo: https://eiriktsarpalis.github.io/csharp-sdk/ cc @stephentoub @halter73

@eiriktsarpalis
Copy link
Contributor

The markdown link checker is failing because we have links pointing to the yet unpopulated gh-pages. Should resolve itself after I merge.

@eiriktsarpalis eiriktsarpalis merged commit 2972fd7 into main Mar 25, 2025
6 of 8 checks passed
@eiriktsarpalis eiriktsarpalis deleted the ddelimarsky/docs branch March 25, 2025 15:43
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.

3 participants