Skip to content

Commit

Permalink
📝 Updated the contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BattleCh1cken committed May 15, 2024
1 parent a0c9347 commit 084b690
Showing 1 changed file with 25 additions and 20 deletions.
45 changes: 25 additions & 20 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ All types of contributions are encouraged and valued. See the [Table of Contents

## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](../docs.pdf).
<!-- FIXME: replace with real url -->

> If you want to ask a question, we assume that you have read the available [Documentation]().
Before you ask a question, it is best to search for existing [Issues](https://github.com/BattleCh1cken/notebookinator.git/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

Expand All @@ -41,21 +43,6 @@ If you then still feel the need to ask a question and need clarification, we rec

We will then take care of the issue as soon as possible.

<!--
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
- IRC
- Slack
- Gitter
- Stack Overflow tag
- Blog
- FAQ
- Roadmap
- E-Mail List
- Forum
-->

## I Want To Contribute

> ### Legal Notice <!-- omit in toc -->
Expand Down Expand Up @@ -153,16 +140,34 @@ You can then [commit](#commit-messages) your changes to your fork. Once you are

### Improving The Documentation

We use [Tidy](https://github.com/Mc-Zen/tidy/tree/main) to generate our documentation. This means that most of our documentation is written directly in the code as comments.
We use a combination of [mdBook](https://github.com/rust-lang/mdBook) and [Tidy](https://github.com/Mc-Zen/tidy/tree/main) to generate our documentation.

You can improve the documentation in the following places:
All of the documentation can be found inside of the [`docs/`](../docs) directory.

- The guides located in [`docs/src/`](../docs/src)
- The comments directly in the code
- The documentation in [`docs.typ`](../docs.typ)
- The template for the docs at [`docs-template.typ`](../docs-template.typ)
- The [README](../README.md)
- The [contributing guide](./CONTRIBUTING.md)(this file)

You can preview your changes locally with the mdbook cli. The first thing you'll need to do is install all of the dependences.

```bash
cargo install --git https://github.com/typst/typst --locked typst-cli
cargo install mdbook
cargo install mdbook-admonish
cargo install --git https://github.com/fenjalien/mdbook-typst-doc.git
```

Once everything has installed, render the documentation with these commands:

```bash
typst compile docs/src/reference.typ --root ./
cd docs
mdbook serve
```

You can then view your notebook by visiting <localhost:8000>.

Once you've made your changes, submit your changes as a pull request, as described above.

## Style Guides
Expand Down

0 comments on commit 084b690

Please sign in to comment.