diff --git a/docs/contributing.md b/docs/contributing.md index ac69a90..f2074d4 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -11,7 +11,7 @@ You can begin by cloning the public repo: git clone https://git.purplecello.org/KylerOlsen/YREA-SLS.git ``` -Create a new branch to work in: +It is recommended to create a new branch to work in: ``` git checkout -b my-feature ``` @@ -26,3 +26,9 @@ git format-patch -1 This will create a file like: `0001-fix-something.patch`. You will email the contents of this file to Kyler Olsen ([Contact Info](https://purplecello.org/contact.html)). The subject should be something like `[PATCH] Fix Something`. + +--- + +If you are not sure where to begin, the documentation is a great place to start! + +--- diff --git a/docs/index.md b/docs/index.md index edb7d06..baf295e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,6 +7,11 @@ Next: Overview # YREA SLS Documentation Stack Language Specification +A statically-typed, stack-based language with pure postfix notation. + +- [Git Repo](https://git.purplecello.org/KylerOlsen/YREA-SLS) +- [Contribution Guide](./contributing.html) + **Sections**: 1. [Overview](./overview.html) 2. [Lexical Structure](./lexical_structure.html) @@ -33,10 +38,11 @@ Next: Overview --- **Other**: +- [Git Repo](https://git.purplecello.org/KylerOlsen/YREA-SLS) - [Contribution Guide](./contributing.html) - [Missing Features](./missing_features.html) -- [SE 3250 Assignment Details](./se_3250_assignment_details.html) -- [Changed](./changes.html) +- [Assignment Details](./se_3250_assignment_details.html) +- [Changes](./changes.html) - [Full Specification](./stack_lang_spec.html) - [C Terminal I/O Reference](./io_ref.html) - [Assignment Slide Show](./slides/SLIDES.html)