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

refactor: repo documentation, crate names #552

Merged
merged 18 commits into from
Apr 23, 2024
Merged

refactor: repo documentation, crate names #552

merged 18 commits into from
Apr 23, 2024

Conversation

simbleau
Copy link
Member

@simbleau simbleau commented Apr 19, 2024

Changes:

  • Introduces the same CHANGELOG we use for vello_svg/velato/bevy_vello. Closes Introduce a changelog #519.
  • README: Fixes broken links, doc lints, etc.

@simbleau simbleau requested review from xStrom and DJMcNab April 19, 2024 23:35
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.

Has something changed in the status of #518?
We should try and settle that before doing this renaming

The other changes seem mostly fine, although I find the aversion to title case in the changelog slightly strange

README.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Daniel McNab <[email protected]>
@simbleau
Copy link
Member Author

simbleau commented Apr 20, 2024

Has something changed in the status of #518? We should try and settle that before doing this renaming

That is a good callout. My guess was that #518 work fell through the cracks to higher priorities.

@xorgy - Is the rename from vello_svg to demo_svg ok? My motivation was to fix having two vello_svgs around.

The other changes seem mostly fine, although I find the aversion to title case in the changelog slightly strange

I just copied other CHANGELOGs, which don't capitalize. But nonetheless I applied your suggestion, we can use capitals.

README.md Outdated Show resolved Hide resolved
@simbleau
Copy link
Member Author

finished rebasing @DJMcNab

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.

Thanks. It'll be good to get changelogs started, even if we've not quite settled on the exact format yet

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@simbleau simbleau requested a review from DJMcNab April 23, 2024 14:14
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
simbleau and others added 2 commits April 23, 2024 10:21
@simbleau simbleau requested a review from DJMcNab April 23, 2024 14:26
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.

Thanks!

CHANGELOG.md Show resolved Hide resolved
@simbleau simbleau added this pull request to the merge queue Apr 23, 2024
Merged via the queue into main with commit 23ac080 Apr 23, 2024
15 checks passed
@simbleau simbleau deleted the update-docs branch April 23, 2024 17:45
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.

Introduce a changelog
2 participants