Skip to content

CONTRIBUTING.md: sections, mkdocs serve, container rebuild #236

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

Merged
merged 1 commit into from
May 31, 2024

Conversation

LinasKo
Copy link
Contributor

@LinasKo LinasKo commented Feb 28, 2024

Description

CONTRIBUTING.md now has sections.

Added instructions:

  • How to rebuild the dev container
  • How to serve the docs (unsure if there's a better way)

Opening a draft PR - let me know if there's a better way to install the dependencies for docs.

Type of change

  • This change requires a documentation update

How has this change been tested, please provide a testcase or example of how you tested the change?

  1. I rebuilt the container, ran the doc dependency install command I added, served the docs.
  2. I checked that contributing.md looks okay in the repo.

Any specific deployment considerations

Is this the best way of installing mkdocs dependencies?

Docs

  • Docs updated? What were the changes:

CONTRIBUTING.md:

  • How to rebuild the dev container
  • How to serve the docs (unsure if there's a better way)

Copy link
Collaborator

@tonylampada tonylampada left a comment

Choose a reason for hiding this comment

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

thank you @LinasKo !

@LinasKo LinasKo marked this pull request as ready for review March 9, 2024 07:59
@LinasKo
Copy link
Contributor Author

LinasKo commented May 31, 2024

devcontainers, devcointainers, devcontainers

Hey @tonylampada,

I think this is a super tiny change that's fallen through the cracks - I think it's both safe and useful to merge 🙂

@tonylampada tonylampada merged commit 3de713a into roboflow:main May 31, 2024
@tonylampada
Copy link
Collaborator

@LinasKo merged!
Next time feel free to merge any of your approved PRs here! :)

@LinasKo
Copy link
Contributor Author

LinasKo commented May 31, 2024

I don't have permissions, I'm afraid

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