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

mommy has lots to explain~ #63

Merged
merged 9 commits into from
Nov 20, 2023
Merged

mommy has lots to explain~ #63

merged 9 commits into from
Nov 20, 2023

Conversation

Gankra
Copy link
Owner

@Gankra Gankra commented Nov 19, 2023

No description provided.

Copy link
Contributor

@workingjubilee workingjubilee left a comment

Choose a reason for hiding this comment

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

gonna need a mommy's-little-copyeditor@jubilee.dev huh

book/src/README.md Outdated Show resolved Hide resolved
book/src/contributing/README.md Outdated Show resolved Hide resolved
book/src/contributing/concepts.md Outdated Show resolved Hide resolved
book/src/contributing/concepts.md Outdated Show resolved Hide resolved
book/src/contributing/concepts.md Outdated Show resolved Hide resolved
book/src/contributing/concepts.md Outdated Show resolved Hide resolved
book/src/contributing/concepts.md Outdated Show resolved Hide resolved
book/src/contributing/concepts.md Outdated Show resolved Hide resolved
book/src/customize/true-roles.md Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
@workingjubilee
Copy link
Contributor

Note: Either in the main README.md, or a README for this particular folder, contributors should be advised on what an "mdbook" is (and prompted to cargo install mdbook and consult mdbook --help) in the likely event they have never seen one. This will allow them to know how to build the documentation. It seems reasonable to assume they have access to the default Rust tooling but, although you would not know this by the frequency of the community use, mdbook is technically not such: it is a user's binary crate.

@Gankra
Copy link
Owner Author

Gankra commented Nov 19, 2023

So strictly speaking they actually want to install oranda and run oranda dev (which uses mdbook as a library and patches several bugs so that it can unify the themes).

I'll think about where to put that info.

Pushed up many more docs.

@workingjubilee
Copy link
Contributor

So strictly speaking they actually want to install oranda and run oranda dev (which uses mdbook as a library and patches several bugs so that it can unify the themes).

Indeed. It just seems important to make sure to document that mdbook is the... institution? in use.

book/src/contributing/adding-moods.md Outdated Show resolved Hide resolved
book/src/contributing/adding-moods.md Outdated Show resolved Hide resolved
book/src/contributing/adding-variables.md Outdated Show resolved Hide resolved
book/src/contributing/adding-variables.md Outdated Show resolved Hide resolved
book/src/customize/moods.md Show resolved Hide resolved
book/src/contributing/releasing.md Outdated Show resolved Hide resolved
@Gankra Gankra merged commit eff1bc1 into main Nov 20, 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.

2 participants