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.

Sign up for GitHub

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

Jump to bottom

Complete v0.1 mdbook #36

Merged
merged 4 commits into from
Nov 8, 2022
Merged

Complete v0.1 mdbook #36

merged 4 commits into from
Nov 8, 2022

Conversation

grjte
Copy link
Contributor

@grjte grjte commented Oct 26, 2022

This PR completes the documentation for v0.1. It documents how to define constraints in the boundary_constraints and transition_constraints sections and makes a few other minor updates for clarity.

Remaining:

  • we'll update the name throughout these docs when we update the name throughout the codebase just prior to releasing v0.1

@grjte grjte requested a review from bobbinth October 26, 2022 15:49
bobbinth
bobbinth requested changes Oct 26, 2022
View reviewed changes
Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

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

Thank you! Looks good! I left a few comments inline, many of them can be addresses in future PRs.

docs/src/description/syntax.md Outdated Show resolved Hide resolved
docs/src/description/constraints.md Outdated Show resolved Hide resolved
docs/src/description/constraints.md Show resolved Hide resolved
docs/src/description/constraints.md Show resolved Hide resolved
docs/src/description/constraints.md Show resolved Hide resolved
docs/src/description/constraints.md Outdated Show resolved Hide resolved
docs/src/description/constraints.md Outdated Show resolved Hide resolved
docs/src/description/constraints.md Show resolved Hide resolved
This was referenced Oct 28, 2022
Closed
Closed
Closed
Open
@grjte grjte requested a review from bobbinth October 28, 2022 04:41
This was referenced Oct 28, 2022
Closed
Merged
@grjte grjte mentioned this pull request Nov 7, 2022
Closed
@grjte grjte requested review from bobbinth and tohrnii and removed request for bobbinth November 7, 2022 12:16
@grjte
Copy link
Contributor Author

grjte commented Nov 7, 2022

@bobbinth this PR is ready for a final review. In addition to the points previously addressed, I made a few more minor tweaks to incorporate fixes added while this was pending and also a to address a few small points @tohrnii noticed.

@tohrnii your review is optional. (I know you are unlikely to be available today/tomorrow)

bobbinth
bobbinth approved these changes Nov 7, 2022
View reviewed changes
Copy link
Contributor

@bobbinth bobbinth 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! Thank you! I left one comment regarding build the mdBook inline.

Also, we probably shouldn't check in .DS_Store file.

docs/book.toml Outdated Show resolved Hide resolved
@grjte
Copy link
Contributor Author

grjte commented Nov 7, 2022

Great, thanks for catching both of these! I'll fix before merging

@grjte grjte merged commit a197d34 into main Nov 8, 2022
@grjte grjte deleted the docs-mdbook branch November 8, 2022 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bobbinth bobbinth bobbinth approved these changes

@tohrnii tohrnii Awaiting requested review from tohrnii

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@grjte @bobbinth