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

Documentation Improvements #23

Merged
merged 16 commits into from
Jun 10, 2024
Merged

Conversation

jenniferjiangkells
Copy link
Member

@jenniferjiangkells jenniferjiangkells commented May 31, 2024

  • Automate documentation publishing
  • Make it more like "here's why YOU should use HealthChain..."
  • Check code runs in doc snippets
  • Add logo

So yes I made some changes in code in this PR that was supposed to be documentation. But I had to make those changes in order to get the code samples in the documentation to run and it's just the two of us so yeah just rolling with it.

CHANGES

  • Set model dump exclude_unset to True - excludes all the fields with empties so that you don't send a huge file to your model
  • Increase timeout for client - running local transformers on cpu takes a few secs. I actually just removed timeout for read operations but might want to pass this in as config in future.
  • Removed markdown validation in CDSResponse - it's just too much effort for not high enough reward
  • Moved docs dependencies out of pyproject.toml

@jenniferjiangkells jenniferjiangkells self-assigned this May 31, 2024
adamkells
adamkells previously approved these changes Jun 10, 2024
docs/quickstart.md Outdated Show resolved Hide resolved
@jenniferjiangkells jenniferjiangkells merged commit e838827 into main Jun 10, 2024
3 checks passed
@jenniferjiangkells jenniferjiangkells deleted the documentation-improvements branch June 11, 2024 01:26
@jenniferjiangkells jenniferjiangkells linked an issue Sep 5, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add API reference and detailed docs
2 participants