Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/Mahidharah/tp
Browse files Browse the repository at this point in the history
* 'master' of https://github.com/Mahidharah/tp: (23 commits)
  fix user guide format
  fix checkstyle
  update user guide format
  update ug header
  Update projects.yml to work
  Update index.md to work
  Update Documentation.md to work
  Update DeveloperGuide.md to work
  Update page.html to work
  Update default.html to work
  Update alt-page.html to work
  Update custom-head.html to work
  Update header.html to work
  Update head.html to work
  Update PPP
  fix ug header
  update ug heading
  fix typo in ug
  fix bugs
  fix check style errors
  ...
  • Loading branch information
Mahidharah committed Nov 9, 2023
2 parents eeb08b9 + aefc76c commit 0d69aa1
Show file tree
Hide file tree
Showing 54 changed files with 731 additions and 984 deletions.
534 changes: 142 additions & 392 deletions docs/DeveloperGuide.md

Large diffs are not rendered by default.

21 changes: 7 additions & 14 deletions docs/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,23 @@ title: Documentation guide

* We use [**Jekyll**](https://jekyllrb.com/) to manage documentation.
* The `docs/` folder is used for documentation.
* To learn how set it up and maintain the project website, follow the guide [
_[se-edu/guides] **Using Jekyll for project documentation**_](https://se-education.org/guides/tutorials/jekyll.html).
* To learn how set it up and maintain the project website, follow the guide [_[se-edu/guides] **Using Jekyll for project documentation**_](https://se-education.org/guides/tutorials/jekyll.html).
* Note these points when adapting the documentation to a different project/product:
* The 'Site-wide settings' section of the page linked above has information on how to update site-wide elements such
as the top navigation bar.
* :bulb: In addition to updating content files, you might have to update the config files `docs\_config.yml`
and `docs\_sass\minima\_base.scss` (which contains a reference to `AB-3` that comes into play when converting
documentation pages to PDF format).
* If you are using Intellij for editing documentation files, you can consider enabling 'soft wrapping' for `*.md` files,
as explained in [_[se-edu/guides] **Intellij IDEA: Useful settings
**_](https://se-education.org/guides/tutorials/intellijUsefulSettings.html#enabling-soft-wrapping)
* The 'Site-wide settings' section of the page linked above has information on how to update site-wide elements such as the top navigation bar.
* :bulb: In addition to updating content files, you might have to update the config files `docs\_config.yml` and `docs\_sass\minima\_base.scss` (which contains a reference to `AB-3` that comes into play when converting documentation pages to PDF format).
* If you are using Intellij for editing documentation files, you can consider enabling 'soft wrapping' for `*.md` files, as explained in [_[se-edu/guides] **Intellij IDEA: Useful settings**_](https://se-education.org/guides/tutorials/intellijUsefulSettings.html#enabling-soft-wrapping)


**Style guidance:**

* Follow the [**_Google developer documentation style guide_**](https://developers.google.com/style).

* Also relevant is the [
_[se-edu/guides] **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html)
* Also relevant is the [_[se-edu/guides] **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html)

**Diagrams:**

* See the [_[se-edu/guides] **Using PlantUML**_](https://se-education.org/guides/tutorials/plantUml.html)

**Converting a document to the PDF format:**

* See the guide [
_[se-edu/guides] **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html)
* See the guide [_[se-edu/guides] **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html)
Loading

0 comments on commit 0d69aa1

Please sign in to comment.