Skip to content

Commit

Permalink
Merge branch 'master' into branch-add-Ui
Browse files Browse the repository at this point in the history
  • Loading branch information
Judy1x4 authored Oct 8, 2024
2 parents 7a28e37 + d828b1f commit 54fc57e
Show file tree
Hide file tree
Showing 65 changed files with 9,109 additions and 1,272 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: MarkBind Action

on:
push:
branches:
- master

jobs:
build_and_deploy:
runs-on: ubuntu-latest
steps:
- name: Install Graphviz
run: sudo apt-get install graphviz
- name: Install Java
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'zulu'
- name: Build & Deploy MarkBind site
uses: MarkBind/markbind-action@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
rootDirectory: './docs'
baseUrl: '/tp' # assuming your repo name is tp
version: '^5.5.2'
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ src/test/data/sandbox/
# MacOS custom attributes files created by Finder
.DS_Store
docs/_site/
docs/_markbind/logs/
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@
* It is designed to cater to users with fast typing speeds.
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
* For the detailed documentation of this project, see the **[ServiceTrack Product Website](https://ay2425s1-cs2103t-t17-2.github.io/tp/)**.

23 changes: 23 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
_markbind/logs/

# Dependency directories
node_modules/

# Production build files (change if you output the build to a different directory)
_site/

# Env
.env
.env.local

# IDE configs
.vscode/
.idea/*
*.iml
55 changes: 27 additions & 28 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,58 @@
---
layout: page
title: About Us
layout: default.md
title: "About Us"
---

We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
# About Us

We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).

You can reach us at the email `seer[at]comp.nus.edu.sg`

## Project team

### John Doe
### Park Seyouong (Judy)

<img src="images/johndoe.png" width="200px">
<img src="images/judy1x4.png" width="200px">

[[homepage](http://www.comp.nus.edu.sg/~damithch)]
[[github](https://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](https://github.com/Judy1x4)]

* Role: Project Advisor
* Role: Documentation

### Jane Doe

<img src="images/johndoe.png" width="200px">
### Lu Ruijian

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
<img src="images/ruijianlu.png" width="200px">

* Role: Team Lead
* Responsibilities: UI
[[github](http://github.com/RuijianLu)]

### Johnny Doe
* Role: member

<img src="images/johndoe.png" width="200px">

[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
### Hu Hong Rui

* Role: Developer
<img src="images/muller317.png" width="200px">

[[github](http://github.com/muller317)] [[portfolio](team/johndoe.md)]

* Role: member
* Responsibilities: Data

### Jean Doe
### Eng Yu Han

<img src="images/johndoe.png" width="200px">
<img src="images/engyuhan.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](http://github.com/engyuhan)]

* Role: Developer
* Responsibilities: Dev Ops + Threading
* Role: member
* Responsibilities: none

### James Doe

<img src="images/johndoe.png" width="200px">
<img src="images/1st2getthisname.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](http://github.com/1st2getthisname)]
[[portfolio](team/1st2getthisname.md)]

* Role: Developer
* Responsibilities: UI
6 changes: 4 additions & 2 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: page
title: Configuration guide
layout: default.md
title: "Configuration guide"
---

# Configuration guide

Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).
13 changes: 8 additions & 5 deletions docs/DevOps.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
---
layout: page
title: DevOps guide
layout: default.md
title: "DevOps guide"
pageNav: 3
---

* Table of Contents
{:toc}
# DevOps guide

--------------------------------------------------------------------------------------------------------------------
<!-- * Table of Contents -->
<page-nav-print />

<!-- -------------------------------------------------------------------------------------------------------------------- -->

## Build automation

Expand Down
Loading

0 comments on commit 54fc57e

Please sign in to comment.