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

use cargo rdme for tree arena #769

Merged
merged 3 commits into from
Dec 5, 2024

Conversation

KGrewal1
Copy link
Contributor

@KGrewal1 KGrewal1 commented Dec 5, 2024

Use cargo rdme for crate readme and check in CI as mentioned in #752 (comment)

Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks

You don't need to ping me in the PR description, especially for a change which can be reviewed by anyone.

@DJMcNab DJMcNab added this pull request to the merge queue Dec 5, 2024
@DJMcNab DJMcNab removed this pull request from the merge queue due to a manual request Dec 5, 2024
Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

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

Looking at it again, we should adopt some of the differences from linebender/color#38.

Those are:

  1. Using --heading-base-level=0 (evaluating this for Masonry would be a reasonable follow-up, not for this PR)
  2. Adding an explanation block comment at the top of the README

There are no intra-doc-links yet, so the hack used for those isn't needed.

@DJMcNab DJMcNab added this pull request to the merge queue Dec 5, 2024
Merged via the queue into linebender:main with commit 3aebc98 Dec 5, 2024
17 checks passed
@KGrewal1 KGrewal1 deleted the cargo-rdme-for-tree-arena branch December 5, 2024 13:46
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