add more guidance and steps to create/consume Topics

This commit is contained in:
Jessie Broke 2022-05-18 10:56:30 -04:00
parent 694ece6ec3
commit f47c5b65d1
8 changed files with 95 additions and 63 deletions

View File

@ -32,6 +32,6 @@
"repelStrength": 12.5586218273514,
"linkStrength": 1,
"linkDistance": 500,
"scale": 0.4530636264839481,
"scale": 0.2112682145499592,
"close": true
}

32
.obsidian/workspace vendored
View File

@ -6,6 +6,23 @@
{
"id": "9b06a6fa4b0536b8",
"type": "leaf",
"dimension": 57.80590717299578,
"pinned": true,
"state": {
"type": "markdown",
"state": {
"file": "pages/Logos Program.md",
"mode": "source",
"backlinks": false,
"source": false
},
"pinned": true
}
},
{
"id": "6fcb5ae32ca29ccf",
"type": "leaf",
"dimension": 42.19409282700422,
"state": {
"type": "markdown",
"state": {
@ -55,7 +72,8 @@
}
],
"direction": "horizontal",
"width": 200.0028419494629
"width": 200.0028419494629,
"collapsed": true
},
"right": {
"id": "5a82e9ac98b3e694",
@ -89,17 +107,17 @@
"width": 300,
"collapsed": true
},
"active": "9b06a6fa4b0536b8",
"active": "6fcb5ae32ca29ccf",
"lastOpenFiles": [
"README.md",
"pages/Topics.md",
"pages/randomly.md",
"pages/Tags.md",
"pages/Logos Program.md",
"pages/Start Here.md",
"pages/libp2p.md",
"pages/Project Waku.md",
"pages/Pasted image 20220513173853.png{width=50%}.md",
"pages/Logos Program.md",
"pages/Data Model and Concurrency.md",
"pages/Project Logos.md",
"pages/Consensus.md",
"pages/Topic Template.md"
"pages/Data Model and Concurrency.md"
]
}

0
.trash/Topics.md Normal file
View File

0
.trash/randomly.md Normal file
View File

View File

@ -4,51 +4,63 @@ End User stories of the "Status Network"
## Welcome to the Knowledge Safe Spawn™
Follow the step-by-step instructions below to begin your Graph View journey.
1. Download and Install Obsidian for your OS by going to: https://obsidian.md/download
1. `Download` and `Install` `Obsidian` for your OS by going to: https://obsidian.md/download
![Obsidian Download](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513173510.png)
2. Navigate to the GitHub repository located here: https://github.com/status-im/network-stories
2. `Navigate` to the `GitHub` repository located here: https://github.com/status-im/network-stories
3. Left-click the green 'Code' button and click 'Open with GitHub Desktop'
3. Left-click the green `'Code'` button and left-click `'Open with GitHub Desktop'`
![Open with GitHub Desktop](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513173743.png)
4. Download and Install GitHub Desktop for your OS (if not previously installed)
4. `Download` and `Install` `GitHub Desktop` for your OS (if not previously installed)
5. Click 'Sign in to Github.com' in GitHub Desktop if you have a pre-existing GitHub account and follow the sub-instructions below.
5. Click `'Sign in to Github.com'` in GitHub Desktop if you have a pre-existing GitHub account and follow the sub-instructions below.
1. Left-click 'Current Repository' in the top-left of the GitHub Desktop application (see below)
1. Left-click `'Current Repository'` in the top-left of the GitHub Desktop application (see below)
![Current Repository](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513181831.png)
2. Click the 'Add' button and left-click 'Clone Repository'
2. Left-click the `'Add'` button and left-click `'Clone Repository'`
![Add and Clone Repository](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513181928.png)
3. Click on the URL tab and paste the network-stories repository: https://github.com/status-im/network-stories
3. Click on the `URL` tab and `paste` the network-stories repository here: https://github.com/status-im/network-stories
4. Copy your 'Local Path' and press 'Clone'
4. Copy your `'Local Path'` and press `'Clone'`
![Copy Local Path and Clone](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513180840.png)
5. Go back to Obsidian and click the 'Open' button to the right of "Open folder as vault - Choose an existing folder of Markdown Files." and Paste the 'Local Path' from above and click 'Open' again to open the directory as an Obsidian Vault
5. Go back to Obsidian and click the `'Open'` button to the right of "Open folder as vault - Choose an existing folder of Markdown Files." and Paste the `'Local Path'` from above and click `'Open'` again to open the directory as an Obsidian Vault
![Open Vault](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513181031.png)
6. Congratulations you did it! You can now access the network-stories 'Graph View' by clicking the icon below
6. Congratulations you did it! You can now access the network-stories `'Graph View'` by left-clicking the icon below
![Access Graph View](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513182600.png)
1. Otherwise, click 'Create your free account' to create a new GitHub account then sign into GitHub Desktop with your newly created account and follow the sub-instructions below.
1. If you created a new GitHub account and signed into GitHub Desktop, click 'Finish' to use the default settings and follow the prompts as necessary.
1. Otherwise, click `'Create your free account'` to create a new GitHub account then sign into GitHub Desktop with your newly created account and follow the sub-instructions below.
1. If you created a new GitHub account and signed into GitHub Desktop, click `'Finish'` to use the default settings and follow the prompts as necessary.
2. Click 'Clone a Repository from the Internet...' from within GitHub Desktop
2. Click `'Clone a Repository from the Internet...'` from within GitHub Desktop
![Clone a Repository](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513175923.png)
3. Click on the URL tab and paste the network-stories repository: https://github.com/status-im/network-stories
3. Click on the `URL` tab and paste the network-stories repository: https://github.com/status-im/network-stories
4. Copy your 'Local Path' (circled below) and press 'Clone'
4. Copy your `'Local Path'` (circled below) and press `'Clone'`
![Copy Local Path and Clone](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513180840.png)
5. Go back to Obsidian and click the 'Open' button to the right of "Open folder as vault - Choose an existing folder of Markdown Files." and paste the 'Local Path' from above and click 'Open' again to open the directory as an Obsidian Vault
5. Go back to Obsidian and left-click the `'Open'` button to the right of "Open folder as vault - Choose an existing folder of Markdown Files." and paste the `'Local Path'` from above and click `'Open'` again to open the directory as an Obsidian Vault
![Paste and Open Vault](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513181031.png)
6. Congratulations you did it! You can now access the network-stories 'Graph View' by clicking the icon below
6. Congratulations you did it! You can now access the network-stories `'Graph View'` by clicking the icon below
![Access Graph View](https://github.com/status-im/network-stories/blob/master/pages/assets/Pasted%20image%2020220513182600.png)
[Insert 'Great you made it' here video]
Now hop to [[Logos Program]] to begin!
Next Steps:
You can now hop to [[Logos Program]] to understand all the moving parts are being worked on.
OR
You can jump right in and begin learning any new [Topic] and/or create new [[Topics]] for others!
WIP
- Explain what a Topic is - link to motif page re: Topics as Recipes
- Add Instructions for Creating new Topics - Insert learning video here?

View File

@ -20,8 +20,8 @@ Dr. Corey Petty
### Purpose
is to provide a "Living Database" through:
1. Searchable Information ([Graph View] w/ Controllable Physics for View Adjustment)
2. Topical Coordination ([Topics] as Connected Pages w/ Link Navigation)
3. Communication Routes ([Tags] for Project Discord w/ Relevant Text-Channel for Live Discussion)
2. Topical Coordination ([[Topics]] as Connected Pages w/ Link Navigation)
3. Communication Routes ([[Tags]] for Project Discord w/ Relevant Text-Channel for Live Discussion)
### Instructions
1. How do I contribute to this notebook? (See 1. Add/Edit Topics Below)
@ -46,37 +46,3 @@ OR
3. Create a PR w/ a description of your changes
---
### **Let's Get Cookin'!**
*Instructions: There are some descriptions below which detail the usage of visual guidance metrics available in the form of "cookbook-like" instructions for how to create and consume information within this document:*
| Gauges | Description | Visualization |
| -------- | :-----------: | :----------: |
|Prep | 1-10 (Ticks/Pips) | [||||||||||] |
|Cook Time | In Minutes | X Minutes |
|Ingredients | Article/Video Links w/ Visual Content | Conceptual & Pictoral "Ingredients List" of Links|
#### **Gauge Definitions:**
Prep (*Difficulty*) is defined as the ease of which the Topic can be generally understood. (Future: Make into more fun visual or something more enjoyable than a difficulty bar.)
Cook Time (*Scope*) is in reference to a qualitative assessment of the breadth and depth of information necessary to learn to gain a decent level of comprehension of a Topic.
Ingredients (*Resources*) is for links relevant to helping people understand the concepts. Number references and use superscript notation to reference mentions in terminology Recipes descriptions.
#### Sample Recipe
See example for creating a `new Recipe` template for a new [Topic] below:
```
- Recipe: Topic
- Prep: [||||||||||]
- Cook Time: X min
- Ingredients:
1. [Insert pictures, videos, article links, research papers, etc.]
```
See below 'Recipe' and modify accordingly to above in Figma.
![[Pasted image 20220507054553.png]]
---

3
pages/Tags.md Normal file
View File

@ -0,0 +1,3 @@
Major Communication Tags:
What are the major communication channels that span research Topics in Discord and text-channels relevant to Codex, Logos and Vac?

33
pages/Topics.md Normal file
View File

@ -0,0 +1,33 @@
# What is a Topic?
### **Let's Get Cookin'!**
*Instructions: There are some descriptions below which detail the usage of visual guidance metrics available in the form of "cookbook-like" instructions for how to create and consume 'Topics' within this document:*
| Gauges | Description | Visualization |
| -------- | :-----------: | :----------: |
|Prep | 1-10 (Ticks/Pips) | [||||||||||] |
|Cook Time | In Minutes | X Minutes |
|Ingredients | Article/Video Links w/ Visual Content | Conceptual & Pictoral "Ingredients List" of Links|
#### **Gauge Definitions:**
Prep (*Difficulty*) is defined as the ease of which the Topic can be generally understood. (Future: Make into more fun visual or something more enjoyable than a difficulty bar.)
Cook Time (*Scope*) is in reference to a qualitative assessment of the breadth and depth of information necessary to learn to gain a decent level of comprehension of a Topic.
Ingredients (*Resources*) is for links relevant to helping people understand the concepts. Number references and use superscript notation to reference mentions in terminology Recipes descriptions.
#### Sample Recipe
See example for creating a `new Recipe` template for a new [Topic] below:
```
- Recipe: Topic
- Prep: [||||||||||]
- Cook Time: X min
- Ingredients:
1. [Insert pictures, videos, article links, research papers, etc.]
```
See below 'Recipe' and modify accordingly to above in Figma.
![[Pasted image 20220507054553.png]]