Skip to content

Commit

Permalink
feat: authors and general styling
Browse files Browse the repository at this point in the history
Signed-off-by: Aaron Pham <contact@aarnphm.xyz>
  • Loading branch information
aarnphm committed Sep 18, 2024
1 parent 9536f2e commit 568f52f
Show file tree
Hide file tree
Showing 55 changed files with 780 additions and 121 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ Recommended to use [Obsidian](https://obsidian.md/) for editing docs.

</details>

For updating author, change the frontmatter to use `author: <github-id>[,<github-id>]`

## pull requests.

Push changes to your fork and follow [this article](https://help.github.com/en/articles/creating-a-pull-request)
Expand Down
202 changes: 202 additions & 0 deletions docs/content/.obsidian.vimrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
" Yank to system clipboard
set clipboard=unnamed

" Go back and forward with Ctrl+O and Ctrl+I
" (make sure to remove default Obsidian shortcuts for these to work)
exmap back obcommand app:go-back
nmap <C-o> :back
exmap forward obcommand app:go-forward
nmap <C-i> :forwardv
" Mapping
nmap ; :
imap jj <Esc>
" Here's an example config that implements many of the features from vim-surround:
exmap surround_wiki surround [[ ]]
exmap surround_double_quotes surround " "
exmap surround_single_quotes surround ' '
exmap surround_brackets surround ( )
exmap surround_square_brackets surround [ ]
exmap surround_curly_brackets surround { }

" NOTE: must use 'map' and not 'nmap'
map [[ :surround_wiki
nunmap s
vunmap s
vmap sa" :surround_double_quotes
vmap sa' :surround_single_quotes
vmap sab :surround_brackets
vmap sa( :surround_brackets
vmap sa) :surround_brackets
vmap sa[ :surround_square_brackets
vmap sa[ :surround_square_brackets
vmap sa{ :surround_curly_brackets
vmap sa} :surround_curly_brackets
" Split Window
exmap vs obcommand workspace:split-vertical
exmap sp obcommand workspace:split-vertical
exmap hs obcommand workspace:split-horizontal
nmap <C-w>v :vs
nmap <C-w>s :hs
exmap focusLeft obcommand editor:focus-left
exmap focusRight obcommand editor:focus-right
exmap focusBottom obcommand editor:focus-bottom
exmap focusTop obcommand editor:focus-top
nmap <C-w>h :focusLeft
nmap <C-w>l :focusRight
nmap <C-w>j :focusBottom
nmap <C-w>k :focusTop
" Quit Buffer
exmap qq obcommand workspace:close
nmap <Space>qq :qq
" Map to Open File
exmap open_file obcommand switcher:open
nmap <Space>f :open_file
" Go Into Link
exmap openlink obcommand editor:open-link-in-new-leaf
nmap go :openlink
nmap gd :openlink
" [g]oto [f]ile (= Follow Link under cursor)
exmap followLinkUnderCursor obcommand editor:follow-link
nmap gf :followLinkUnderCursor
"""""""""""""""""""""""""""""""""""""""""""""""" "
"""""""""""" All Available Commands """""""""""" "
" :obcommand and <opt + cmd + i> to open console "
"""""""""""""""""""""""""""""""""""""""""""""""" "
" Available commands: editor:save-file
" editor:follow-link
" editor:open-link-in-new-leaf
" editor:open-link-in-new-split
" editor:open-link-in-new-window
" editor:focus-top
" editor:focus-bottom
" editor:focus-left
" editor:focus-right
" workspace:toggle-pin
" workspace:split-vertical
" workspace:split-horizontal
" workspace:toggle-stacked-tabs
" workspace:edit-file-title
" workspace:copy-path
" workspace:copy-url
" workspace:undo-close-pane
" workspace:export-pdf
" editor:rename-heading
" workspace:open-in-new-window
" workspace:move-to-new-window
" workspace:next-tab
" workspace:goto-tab-1
" workspace:goto-tab-2
" workspace:goto-tab-3
" workspace:goto-tab-4
" workspace:goto-tab-5
" workspace:goto-tab-6
" workspace:goto-tab-7
" workspace:goto-tab-8
" workspace:goto-last-tab
" workspace:previous-tab
" workspace:new-tab
" app:go-back
" app:go-forward
" app:open-vault
" theme:use-dark
" theme:use-light
" theme:switch
" app:open-settings
" app:show-release-notes
" markdown:toggle-preview
" workspace:close
" workspace:close-window
" workspace:close-others
" app:delete-file
" app:toggle-left-sidebar
" app:toggle-right-sidebar
" app:toggle-default-new-pane-mode
" app:open-help
" app:reload
" app:show-debug-info
" window:toggle-always-on-top
" window:zoom-in
" window:zoom-out
" window:reset-zoom
" file-explorer:new-file
" file-explorer:new-file-in-new-pane
" open-with-default-app:open
" file-explorer:move-file
" open-with-default-app:show
" editor:open-search
" editor:open-search-replace
" editor:focus
" editor:toggle-fold
" editor:fold-all
" editor:unfold-all
" editor:fold-less
" editor:fold-more
" editor:insert-wikilink
" editor:insert-embed
" editor:insert-link
" editor:insert-tag
" editor:set-heading
" editor:set-heading-0
" editor:set-heading-1
" editor:set-heading-2
" editor:set-heading-3
" editor:set-heading-4
" editor:set-heading-5
" editor:set-heading-6
" editor:toggle-bold
" editor:toggle-italics
" editor:toggle-strikethrough
" editor:toggle-highlight
" editor:toggle-code
" editor:toggle-blockquote
" editor:toggle-comments
" editor:toggle-bullet-list
" editor:toggle-numbered-list
" editor:toggle-checklist-status
" editor:cycle-list-checklist
" editor:insert-callout
" editor:swap-line-up
" editor:swap-line-down
" editor:attach-file
" editor:delete-paragraph
" editor:toggle-spellcheck
" editor:context-menu
" file-explorer:open
" file-explorer:reveal-active-file
" global-search:open
" switcher:open
" graph:open
" graph:open-local
" graph:animate
" backlink:open
" backlink:open-backlinks
" backlink:toggle-backlinks-in-document
" canvas:new-file
" canvas:export-as-image
" outgoing-links:open
" outgoing-links:open-for-current
" tag-pane:open
" daily-notes
" daily-notes:goto-prev
" daily-notes:goto-next
" insert-template
" insert-current-date
" insert-current-time
" note-composer:merge-file
" note-composer:split-file
" note-composer:extract-heading
" command-palette:open
" starred:open
" starred:star-current-file
" outline:open
" outline:open-for-current
" file-recovery:open
" editor:toggle-source
2 changes: 1 addition & 1 deletion docs/content/.obsidian/app.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@
"autoPairBrackets": true,
"smartIndentList": true,
"defaultViewMode": "source"
}
}
5 changes: 1 addition & 4 deletions docs/content/Checklists/Code-Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@
id: Code-Checklist
tags:
- checklist
author: smiths
date: "2024-09-16"
title: Source Code Checklist
---

Spencer Smith

\today

- Identifier naming

- [ ] Identifier names are consistent
Expand Down
5 changes: 1 addition & 4 deletions docs/content/Checklists/MG-Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@
id: MG-Checklist
tags:
- checklist
author: smiths
date: "2024-09-16"
title: MG Checklist
---

Spencer Smith

\today

- Follows writing checklist (full checklist provided in a separate document)

- [ ] LaTeX points
Expand Down
5 changes: 1 addition & 4 deletions docs/content/Checklists/MIS-Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@
id: MIS-Checklist
tags:
- checklist
author: smiths
date: "2024-09-16"
title: MIS Checklist
---

Spencer Smith

\today

- Follows writing checklist (full checklist provided in a separate document)

- [ ] LaTeX points
Expand Down
5 changes: 1 addition & 4 deletions docs/content/Checklists/POC-Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@
id: POC-Checklist
tags:
- checklist
author: smiths
date: "2024-09-16"
title: POC Checklist
---

Spencer Smith

\today

The Proof of Concept Demonstration is an important milestone for assessing the state of the project, both with respect to the project scope and the functioning of the team itself.

- Project Status/scope
Expand Down
5 changes: 1 addition & 4 deletions docs/content/Checklists/ProbState-Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@
id: ProbState-Checklist
tags:
- checklist
author: smiths
date: "2024-09-16"
title: Problem Statement and Goals Checklist
---

Spencer Smith

\today

- The source for the document

- [ ] The source is text-based, like LaTeX, [Markdown](https://en.wikipedia.org/wiki/Markdown), [Emacs Org Mode](https://en.wikipedia.org/wiki/Org-mode), etc.
Expand Down
5 changes: 1 addition & 4 deletions docs/content/Checklists/SRS-Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@
id: SRS-Checklist
tags:
- checklist
author: smiths
date: "2024-09-16"
title: SRS and CA Checklist
---

Spencer Smith

September 16, 2024

This checklist is specific to the Smith et al template [SmithAndLai2005, SmithEtAl2007] for documenting requirements for scientific software, but many of the points can be abstracted and applied to other templates.

- Follows writing checklist (full checklist provided in a separate document)
Expand Down
5 changes: 1 addition & 4 deletions docs/content/Checklists/VnV-Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@
id: VnV-Checklist
tags:
- checklist
author: smiths
date: "2024-09-16"
title: System Verification and Validation Plan Checklist
---

Spencer Smith

September 16, 2024

- Follows writing checklist (full checklist provided in a separate document)
- [ ] LaTeX points
- [ ] Structure
Expand Down
5 changes: 1 addition & 4 deletions docs/content/Checklists/Writing-Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@
id: Writing-Checklist
tags:
- checklist
author: smiths
date: "2024-09-16"
title: Writing Checklist
---

Spencer Smith

September 16, 2024

The following checklist should be applied to the documents that you write.

- LaTeX points
Expand Down
14 changes: 3 additions & 11 deletions docs/content/Design/SoftArchitecture/MG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,17 @@
id: MG
tags:
- design
author: aarnphm,waleedmalik7,nebrask,Hoshino-Kiichi
date: "2024-09-16"
title: Module Guide for [Program Name]
title: Module Guide
---

<div style="text-align: center;">
<a href="#">Team #23, [Team Name]</a><br>
<a href="https:/github.com/aarnphm">Aaron Pham</a><br>
<a href="https://github.com/waleedmalik7">Waleed Malik</a><br>
<a href="https://github.com/nebrask">Nebras Khan</a><br>
<a href="https://github.com/Hoshino-Kiichi">Lucas Li</a>
</div>

Sept. 16 2024

## Revision History

| **Date** | **Version** | **Notes** |
| ------------- | ----------- | ------------------ |
| Sept. 16 2024 | 0.0 | Initial skafolding |
| Sept. 16 2024 | 0.1 | Initial setup |

## Reference Material

Expand Down
13 changes: 2 additions & 11 deletions docs/content/Design/SoftDetailedDes/MIS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,11 @@
id: MIS
tags:
- design
author: aarnphm,waleedmalik7,nebrask,Hoshino-Kiichi
date: "2024-09-16"
title: Module Interface Specification for \progname{}
title: Module Interface Specification
---

<div style="text-align: center;">
<a href="#">Team #23, [Team Name]</a><br>
<a href="https:/github.com/aarnphm">Aaron Pham</a><br>
<a href="https://github.com/waleedmalik7">Waleed Malik</a><br>
<a href="https://github.com/nebrask">Nebras Khan</a><br>
<a href="https://github.com/Hoshino-Kiichi">Lucas Li</a>
</div>

Sept. 16 2024

## Revision History

| **Date** | **Version** | **Notes** |
Expand Down
Loading

0 comments on commit 568f52f

Please sign in to comment.