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

doc: Rework docs to align with Rust and other libs #93

Merged
merged 14 commits into from
Dec 3, 2024

Conversation

crandmck
Copy link
Contributor

@crandmck crandmck commented Nov 19, 2024

The main purpose of this PR is to streamline the main README file and move some of the content from there into new files in the docs directory, similar to restructuring I'm doing in other repos:

Because the existing docs directory contains the generated API docs, I renamed that dir to api-docs and updated the script command in package.json. Unfortunately, re-running the script apparently touched ALL the generated API doc .md files, making this PR much bigger than anticipated.

@tmathern I'm not sure if that's a problem...LMK if you want me to try to find a way to avoid this side-effect.

Copy link

changeset-bot bot commented Nov 19, 2024

⚠️ No Changeset found

Latest commit: cfec12f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@crandmck crandmck changed the title Rework docs to align with Rust and other libs doc: Rework docs to align with Rust and other libs Nov 19, 2024
@crandmck crandmck changed the title doc: Rework docs to align with Rust and other libs doc: Rework docs to align with Rust and other libs [WIP] Nov 19, 2024
@crandmck crandmck marked this pull request as draft November 19, 2024 18:46
@crandmck crandmck marked this pull request as ready for review November 25, 2024 17:48
@crandmck crandmck requested a review from tmathern November 25, 2024 17:48
@crandmck crandmck changed the title doc: Rework docs to align with Rust and other libs [WIP] doc: Rework docs to align with Rust and other libs Nov 26, 2024
@tmathern
Copy link
Contributor

tmathern commented Dec 3, 2024

I think it's intended to re-generate the docs. It doesn't have the smarts yet to look if there was a real underlying change or not.

docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
@crandmck crandmck merged commit e21736b into main Dec 3, 2024
4 checks passed
@crandmck crandmck deleted the crandmck/docs-overhaul branch December 3, 2024 19:29
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