-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from osoc24/2-handover-write-handover-documenta…
…tion Getting Started & Lexicon
- Loading branch information
Showing
5 changed files
with
251 additions
and
98 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,63 @@ | ||
| # Markdown Extension Examples | ||
| --- | ||
| title: Introduction | ||
| lang: en-US | ||
| next: | ||
| link: "/lexicon" | ||
| text: "Lexicon" | ||
| --- | ||
|
|
||
| This page demonstrates some of the built-in markdown extensions provided by VitePress. | ||
| # Welcome to the LOAMA documentation website! | ||
|
|
||
| ## Syntax Highlighting | ||
| > **L**inked **O**pen **A**ccess **M**anagement **A**pp | ||
| VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting: | ||
| This website is meant for documenting the LOAMA project, the different dependencies, and additional notes for future development. | ||
|
|
||
| **Input** | ||
| ::: tip :mag_right: Look around! | ||
| To navigate through the handover, you can use the **header**, **sidebar**, and **search bar**. | ||
| ::: | ||
|
|
||
| ````md | ||
| ```js{4} | ||
| export default { | ||
| data () { | ||
| return { | ||
| msg: 'Highlighted!' | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| ```` | ||
| ## Goals | ||
|
|
||
| **Output** | ||
| The LOAMA project was born out of 3 goals: | ||
| 1. **Allow people to manage SOLID permissions**: Solid pods allow you to retain your data, but managing who can access that data hasn't been easy. LOAMA wants to make this easier by providing **a user-friendly way to manage those permissions.** | ||
| 2. **Envision a privacy-focused way to request permission**: Applications can use Solid pods, which allow users to bring and manage their own data, but how would an application request those permissions in a clear and privacy-first way? | ||
| 3. **Make Solid and its benefits more clear**: Solid allows for control of your data, but that control also brings a lot of complexity for users. LOAMA tries to make this more understandable by providing a revised [Lexicon](/lexicon) and creating an interface that is focused on ease of use. | ||
|
|
||
| ```js{4} | ||
| export default { | ||
| data () { | ||
| return { | ||
| msg: 'Highlighted!' | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| [**Read more here :arrow_right:**](/project/goal.md) | ||
|
|
||
| ## Custom Containers | ||
| ## Research | ||
|
|
||
| **Input** | ||
| In order to understand our users and how they would interact with our project, we spent time defining our target audience and creating a fitting theme by taking inspiration from the [Solid Project](https://solidproject.org). | ||
|
|
||
| ```md | ||
| ::: info | ||
| This is an info box. | ||
| ::: | ||
| [**Read more here :arrow_right:**](/project/audience.md) | ||
|
|
||
| ::: tip | ||
| This is a tip. | ||
| ::: | ||
| ## Deliverables | ||
|
|
||
| ::: warning | ||
| This is a warning. | ||
| ::: | ||
| Thanks to research, we gained a steady foundation to create our application. These applications were created and developed with feedback from [Imec](https://www.imec-int.com/) and [IDLab](https://www.ugent.be/ea/idlab/en). From their feedback and the entire osoc team's, we designed and developed the following applications: | ||
| - [Loama :arrow_right:](/loama/index.md) | ||
| - [Mockbook :arrow_right:](/toco/mockbook/index.md) | ||
| - [DoctorApp :arrow_right:](/toco/doctorapp/index.md) | ||
|
|
||
| ::: danger | ||
| This is a dangerous warning. | ||
| ::: | ||
| ## Future Prospects | ||
|
|
||
| ::: details | ||
| This is a details block. | ||
| ::: | ||
| ``` | ||
| This project was created in just 4 weeks, but in order to help future development for LOAMA, we provide an overview of the current [limitations](/loama/limitations.md) and [future considerations](/loama/feedback.md) for the project. | ||
|
|
||
| **Output** | ||
| ## Brought by IMEC & IDLab | ||
|
|
||
| ::: info | ||
| This is an info box. | ||
| ::: | ||
| This project was made possible by [Imec](https://www.imec-int.com/) and [IDLab](https://www.ugent.be/ea/idlab/en): | ||
|
|
||
| ::: tip | ||
| This is a tip. | ||
| ::: | ||
| - Imec is the world's leading independent nanoelectronics R&D hub. The combination of their talent, infrastructure, and partner network enables breakthroughs towards smaller, faster, more affordable, and more sustainable microchips. | ||
|
|
||
| ::: warning | ||
| This is a warning. | ||
| ::: | ||
| - IDLab is a collaboration between [UGent](https://www.ugent.be/) and [Imec](https://www.imec-int.com/) and performs research on a wide range of topics, such as AI, IoT, Networking, Circuit design and more. | ||
|
|
||
| ::: danger | ||
| This is a dangerous warning. | ||
| ::: | ||
| ::: tip :rocket: Powered by OSOC | ||
|
|
||
| This project was created during OSOC 2024, a yearly event where students are giving the opportunity to create a proof-of-concept for a cooperation. OSOC allows students to: | ||
| - Work on real projects and showcase their work | ||
| - Learn from industry experts thanks to several presentation, etc... | ||
| - Hone their skills and work within a group composed of different technological profiles, like developers, designers, innovation, etc... | ||
|
|
||
| ::: details | ||
| This is a details block. | ||
| Want to join, coach, sponser or start an amazing project, just like this one? You can find more info on the [OSOC website](https://osoc.be/)! | ||
| ::: | ||
|
|
||
| ## More | ||
|
|
||
| Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). |
Oops, something went wrong.