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

Add documentation to project #68

Merged
merged 9 commits into from
Dec 6, 2024
Merged

Add documentation to project #68

merged 9 commits into from
Dec 6, 2024

Conversation

travishathaway
Copy link
Collaborator

@travishathaway travishathaway commented Dec 4, 2024

Fixes: #67

To build and test locally run the following:

# From docs/
conda env create -f environment.yml --yes
conda activate conda-anaconda-telemetry-docs
make html

Serve with:

python -m http.server 8001 --directory _build/html

@travishathaway travishathaway marked this pull request as ready for review December 4, 2024 16:41
Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

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

I've got some general punctuation and wording edits for you, but otherwise, this looks great to me! A good primer for people

docs/dev/index.md Outdated Show resolved Hide resolved
docs/dev/index.md Outdated Show resolved Hide resolved
docs/dev/index.md Outdated Show resolved Hide resolved
docs/dev/index.md Outdated Show resolved Hide resolved
Co-authored-by: Katherine Kinnaman <[email protected]>
Copy link
Member

@jezdez jezdez left a comment

Choose a reason for hiding this comment

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

Looking good! Just a minor suggestion regarding the sitemap

docs/robots.txt Outdated Show resolved Hide resolved
Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

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

LGTM!

@jezdez jezdez merged commit 429f2ac into main Dec 6, 2024
16 checks passed
@jezdez jezdez deleted the issue-67 branch December 6, 2024 17:58
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.

Add documentation for the project
3 participants