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

makefile: add support for passing docs serve addr #50

Conversation

devenbhooshan
Copy link
Contributor

A very, very tiny change.

I added the ability to serve docs from different ports. I run some other services at this port on localhost. It is a good practice to expose this.

Separate suggestion

To ease the development, we should add How to run tests/docs/ locally guide in the readme. One can check the makefile, but it would be good to put it in the readme to make it more obvious.

@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (41d06eb) 40.91% compared to head (e8b5198) 40.91%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #50   +/-   ##
=======================================
  Coverage   40.91%   40.91%           
=======================================
  Files          16       16           
  Lines         980      980           
=======================================
  Hits          401      401           
  Misses        579      579           
Flag Coverage Δ
unittests 40.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Collaborator

@ShreyaR ShreyaR left a comment

Choose a reason for hiding this comment

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

@devenbhooshan this makes sense!

I like the idea of having instructions in the readme for running tests and serving docs. I added at #52 to track that!

@ShreyaR ShreyaR merged commit b881dbb into guardrails-ai:main Mar 16, 2023
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.

None yet

2 participants