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

Rearrange docs and align content with README #571

Merged
merged 1 commit into from
Dec 21, 2023

Conversation

blakehatch
Copy link
Contributor

@blakehatch blakehatch commented Dec 21, 2023

Description

Align content in docs with README and restructure page order.

Fixes #567

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Please also list any relevant details for your test configuration

Checklist

  • Updated documentation if needed
  • Tests added/amended
  • bazel test //... passes locally
  • PR is contained in a single commit, using git amend see some docs

This change is Reviewable

@blakehatch blakehatch requested review from aaronmondal and MarcusSorealheis and removed request for aaronmondal December 21, 2023 15:59
Copy link
Member

@adam-singer adam-singer left a comment

Choose a reason for hiding this comment

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

Reviewed 3 of 3 files at r1, all commit messages.
Reviewable status: 0 of 1 LGTMs obtained, and pending CI: pre-commit-checks

Copy link
Member

@aaronmondal aaronmondal left a comment

Choose a reason for hiding this comment

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

Reviewed all commit messages.
Reviewable status: 0 of 1 LGTMs obtained, and pending CI: pre-commit-checks

Copy link
Member

@aaronmondal aaronmondal left a comment

Choose a reason for hiding this comment

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

@blakehatch @MarcusSorealheis Should we pull this in before #572?

Reviewable status: 0 of 1 LGTMs obtained, and pending CI: pre-commit-checks

Copy link
Contributor Author

@blakehatch blakehatch left a comment

Choose a reason for hiding this comment

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

Doesn't matter too much since the site will reflect the changes either way but up to @MarcusSorealheis on that.

Reviewable status: 0 of 1 LGTMs obtained, and pending CI: Analyze (javascript-typescript), Analyze (python), Bazel Dev / ubuntu-22.04, Cargo Dev / ubuntu-22.04, Local / ubuntu-22.04, Remote / large-ubuntu-22.04, asan / ubuntu-22.04, docker-compose-compiles-nativelink (20.04), docker-compose-compiles-nativelink (22.04), integration-tests (20.04), integration-tests (22.04), pre-commit-checks, publish-image, ubuntu-20.04, ubuntu-20.04 / stable, ubuntu-22.04, ubuntu-22.04 / stable, windows-2022 / stable

@blakehatch blakehatch force-pushed the align-docs branch 5 times, most recently from a0916a7 to 3157dce Compare December 21, 2023 22:44
@blakehatch blakehatch changed the title Rearranged docs and aligned content with README Rearrange docs and aligned content with README Dec 21, 2023
@blakehatch blakehatch changed the title Rearrange docs and aligned content with README Rearrange docs and align content with README Dec 21, 2023
@MarcusSorealheis
Copy link
Collaborator

I think this is fine.

Copy link
Collaborator

@MarcusSorealheis MarcusSorealheis left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewable status: :shipit: complete! 1 of 1 LGTMs obtained

@blakehatch blakehatch merged commit beb87cf into TraceMachina:main Dec 21, 2023
20 checks passed
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.

Align Docs and READMEs
4 participants