git.iko.soy/urbit.org
on master help sign in
links, guide styling, and guide enumeration
158577eGordon
content/getting-started/cli.md+2−2
compare with master
unifiedsplit
@@ -82,9 +82,9 @@ There are five kinds of Urbit IDs but to get started you only need to know about
82
82
83A planet name looks like `~sampel-palnet`.
83A planet name looks like `~sampel-palnet`.
84
84
85−[Follow this guide](/getting-started/planet) if you have already acquired a planet.
85+[Follow this guide](/getting-started/) if you have already acquired a planet.
86
86
87−[Find a planet to purchase](/getting-started#get-a-planet)
87+[Find a planet to purchase](/getting-started/get-planet)
88
88
89---
89---
90
90
content/getting-started/desktop.md+8−5
@@ -4,7 +4,7 @@ description = "Run Urbit locally as a desktop application"
4weight = 1
4weight = 1
5+++
5+++
6
6
7−### Get Port
7+### 1. Get Port
8
8
9Port is a desktop GUI application that allows you to spin up, access, and manage your Urbit ships without any knowledge of the command line or Urbit binary.
9Port is a desktop GUI application that allows you to spin up, access, and manage your Urbit ships without any knowledge of the command line or Urbit binary.
10
10
@@ -82,20 +82,23 @@ Or to install `snap` for your distribution, snapcraft provides [installation ins
82}
82}
83</style>
83</style>
84
84
85−### Launch a comet
85+### 2. Boot a comet
86
86
87A comet serves as a temporary identity for the network. It works just fine for checking out the network, but to download applications and get the full functionality of Urbit ID you’ll need a to get a planet.
87A comet serves as a temporary identity for the network. It works just fine for checking out the network, but to download applications and get the full functionality of Urbit ID you’ll need a to get a planet.
88
88
89−Start Port and hit the **Start without an ID** button. It'll take a few minutes to spin up the new comet. Once that's finished, click **Launch Ship into Urbit** and you'll be on the network.
89+Start Port and hit the **Start without an ID** button. It'll take a few minutes to spin up the new comet.
90
90
91![](https://media.urbit.org/site/getting-started/getting-started-easy-1.png)
91![](https://media.urbit.org/site/getting-started/getting-started-easy-1.png)
92
92
93+### 3. Launch your ship
94+
95+Once that's finished, click **Launch Ship into Urbit** and you'll be on the network.
96+
93−<div className="bg-wall-100 p-4 rounded-xl" style="padding-bottom: 1rem;">
97+<div className="bg-wall-100 p-7 rounded-xl markdown-callout">
94
98
95**Want to combine the simplicity of Port with a permanent Urbit ID?**
99**Want to combine the simplicity of Port with a permanent Urbit ID?**
96
100
97If you already have a planet, first get your keyfile.
101If you already have a planet, first get your keyfile.
98−
99Start Port, click the **Boot a fresh ID** option. Give your ship a name, and in the **Shipname** field, enter your planet name, like `~sampel-palnet`. For the **Key File** field, browse to the keyfile, select it, and hit **Continue**.
102Start Port, click the **Boot a fresh ID** option. Give your ship a name, and in the **Shipname** field, enter your planet name, like `~sampel-palnet`. For the **Key File** field, browse to the keyfile, select it, and hit **Continue**.
100
103
101Port will boot your Urbit in a few minutes!
104Port will boot your Urbit in a few minutes!
content/getting-started/getting-around.md+5−5
@@ -4,7 +4,7 @@ description = "Get around your urbit"
4weight = 4
4weight = 4
5+++
5+++
6
6
7−### Get oriented
7+### 1. Get oriented
8
8
9After you've logged into your Urbit for the first time, you're officially an Urbiter! You've unlocked the entire Urbit network with your newly-minted ID — the key to your new digital life.
9After you've logged into your Urbit for the first time, you're officially an Urbiter! You've unlocked the entire Urbit network with your newly-minted ID — the key to your new digital life.
10
10
@@ -16,7 +16,7 @@ Above those are buttons to view System Preferences and Help and Support and chec
16
16
17You'll likely want to focus on finding and joining new communities, which you can do with the **Groups** app. Click on the box to open the application.
17You'll likely want to focus on finding and joining new communities, which you can do with the **Groups** app. Click on the box to open the application.
18
18
19−### Join a few groups with fellow Urbiters
19+### 2. Join a few groups with fellow Urbiters
20
20
21No two people will ever have the same experience on Urbit. That depends entirely on who you find and where they invite you to join them. But we can set you down a good path.
21No two people will ever have the same experience on Urbit. That depends entirely on who you find and where they invite you to join them. But we can set you down a good path.
22
22
@@ -32,7 +32,7 @@ Here are a few more useful groups to join:
32- [`~middev/the-forge`](/groups/~middev/the-forge): A group for sharing, discussing, and discovering new Urbit applications.
32- [`~middev/the-forge`](/groups/~middev/the-forge): A group for sharing, discussing, and discovering new Urbit applications.
33- [`~hocwyn-tipwex/uqbar-event-horizon`](/groups/~hocwyn-tipwex/uqbar-event-horizon): A community around [Uqbar](https://uqbar.network), a company creating applications and experiences on top of Urbit — notably EScape, which is an alternative to the default Groups application for joining communities and messaging with other Urbiters.
33- [`~hocwyn-tipwex/uqbar-event-horizon`](/groups/~hocwyn-tipwex/uqbar-event-horizon): A community around [Uqbar](https://uqbar.network), a company creating applications and experiences on top of Urbit — notably EScape, which is an alternative to the default Groups application for joining communities and messaging with other Urbiters.
34
34
35−### Get more Urbit apps
35+### 3. Get more Urbit apps
36
36
37Groups are great, but Urbit goes way deeper with apps that are developed specifically for Urbit and use P2P networking for everything.
37Groups are great, but Urbit goes way deeper with apps that are developed specifically for Urbit and use P2P networking for everything.
38
38
@@ -48,7 +48,7 @@ Some popular apps to get things moving:
48- [Studio](/applications/~tirrel/studio): Tools for making money on the Urbit network.
48- [Studio](/applications/~tirrel/studio): Tools for making money on the Urbit network.
49- [Wrdu](/applications/~magped-magped-rabsef-bicrym/wrdu): A Wordle clone.
49- [Wrdu](/applications/~magped-magped-rabsef-bicrym/wrdu): A Wordle clone.
50
50
51−### Get help
51+### 4. Get help
52
52
53If you need help getting around Urbit, the best place to go is the official Urbit community: [`~bitbet-bolbel/urbit-community`](/groups/~bitbet-bolbel/urbit-community). Those in the Help channel are willing to troubleshoot or provide links to resources to help you get out of a jam.
53If you need help getting around Urbit, the best place to go is the official Urbit community: [`~bitbet-bolbel/urbit-community`](/groups/~bitbet-bolbel/urbit-community). Those in the Help channel are willing to troubleshoot or provide links to resources to help you get out of a jam.
54
54
@@ -58,7 +58,7 @@ If you're having trouble with your planet or the hosting provider that's running
58
58
59And if you can't get through this guide and launch into Urbit, you may have luck with the [Urbit Live community](https://t.me/UrbitLiveGroup) on Telegram.
59And if you can't get through this guide and launch into Urbit, you may have luck with the [Urbit Live community](https://t.me/UrbitLiveGroup) on Telegram.
60
60
61−### What's next?
61+### 5. What's next?
62
62
63You made it! You did the work and now have your Final Computer.
63You made it! You did the work and now have your Final Computer.
64
64
content/getting-started/hosted.md+2−2
@@ -4,7 +4,7 @@ description = "Run Urbit on a managed service"
4weight = 3
4weight = 3
5+++
5+++
6
6
7−### Select a hosting provider
7+### 1. Select a hosting provider
8
8
9Hosting providers can sell you a planet and manage the hosting for you for a regular fee. We recommend [Urbit Host](https://urbithost.com) (not directly affiliated with Urbit.org) for quickly acquiring a planet and the hosting required to make your Urbit experience accessible from anywhere.
9Hosting providers can sell you a planet and manage the hosting for you for a regular fee. We recommend [Urbit Host](https://urbithost.com) (not directly affiliated with Urbit.org) for quickly acquiring a planet and the hosting required to make your Urbit experience accessible from anywhere.
10
10
@@ -14,7 +14,7 @@ Two important points about hosting providers:
14
14
15- Urbit has portable data, so you should be able to work with a hosting provider to download all your data and boot up elsewhere if you choose to migrate or start self-hosting.
15- Urbit has portable data, so you should be able to work with a hosting provider to download all your data and boot up elsewhere if you choose to migrate or start self-hosting.
16
16
17−### Log in
17+### 2. Log in
18
18
19The exact steps for logging into your Urbit will depend on your hosting provider's infrastructure and the flow they've developed. If you have questions about logging into your hosted Urbit ship, contact their support.
19The exact steps for logging into your Urbit will depend on your hosting provider's infrastructure and the flow they've developed. If you have questions about logging into your hosted Urbit ship, contact their support.
20
20
content/getting-started/installing-applications.md+4−4
@@ -4,7 +4,7 @@ tag = "additional"
4weight = 3
4weight = 3
5+++
5+++
6
6
7−## 1. Get on the network
7+### 1. Get on the network
8
8
9First, you’ll need to get on Urbit. You can quickly check out the network by [downloading the Port application](https://github.com/urbit/port) and booting up a comet–a temporary Urbit ID.
9First, you’ll need to get on Urbit. You can quickly check out the network by [downloading the Port application](https://github.com/urbit/port) and booting up a comet–a temporary Urbit ID.
10
10
@@ -12,13 +12,13 @@ For long-term use, you’ll want to get a permanent Urbit ID and consider a runn
12
12
13Read our [Getting Started guide](https://urbit.org/install) for details.
13Read our [Getting Started guide](https://urbit.org/install) for details.
14
14
15−## 2. Finding applications
15+### 2. Finding applications
16
16
17Urbit is still in its early stages, so you’ll need to join groups and browse around the network to discover new applications as they are being brought up.
17Urbit is still in its early stages, so you’ll need to join groups and browse around the network to discover new applications as they are being brought up.
18
18
19However, we can get started a simple app from Urbit developer [`~paldev`](/ids/~paldev).
19However, we can get started a simple app from Urbit developer [`~paldev`](/ids/~paldev).
20
20
21−## 3. Search for a Developer
21+### 3. Search for a Developer
22
22
23Once you’re on the network, you’ll see and large tiled interface with a few applications installed and a search bar on the top of the page.
23Once you’re on the network, you’ll see and large tiled interface with a few applications installed and a search bar on the top of the page.
24
24
@@ -30,7 +30,7 @@ For example, to install the picture application, search for `~paldev` and then c
30
30
31![](https://media.urbit.org/site/application/app-guide2.png)
31![](https://media.urbit.org/site/application/app-guide2.png)
32
32
33−## 4. Get the Application
33+### 4. Get the Application
34
34
35After selecting the “picture” app, a pane will open that shows some information about the application. Go ahead and click the “Get App” button, and confirm the following modal window to begin the installation process.
35After selecting the “picture” app, a pane will open that shows some information about the application. Go ahead and click the “Get App” button, and confirm the following modal window to begin the installation process.
36
36
content/getting-started/joining-groups.md+6−6
@@ -4,7 +4,7 @@ tag = "additional"
4weight = 2
4weight = 2
5+++
5+++
6
6
7−## 1. Get on the network
7+### 1. Get on the network
8
8
9First, you’ll need to get on Urbit. You can quickly check out the network by [downloading the Port application](https://github.com/urbit/port) and booting up a comet–a temporary Urbit ID.
9First, you’ll need to get on Urbit. You can quickly check out the network by [downloading the Port application](https://github.com/urbit/port) and booting up a comet–a temporary Urbit ID.
10
10
@@ -12,13 +12,13 @@ For long-term use, you’ll want to get a permanent Urbit ID and consider a runn
12
12
13Read our [Getting Started guide](https://urbit.org/install) for details.
13Read our [Getting Started guide](https://urbit.org/install) for details.
14
14
15−## 2. Open the Groups app
15+### 2. Open the Groups app
16
16
17Once you’re on the network, you’ll see and large tiled interface with a few applications installed: Terminal, Groups, and Bitcoin. Click on Groups.
17Once you’re on the network, you’ll see and large tiled interface with a few applications installed: Terminal, Groups, and Bitcoin. Click on Groups.
18
18
19![](https://media.urbit.org/site/group/groups-guide1.png)
19![](https://media.urbit.org/site/group/groups-guide1.png)
20
20
21−## 3. Enter the group shortcode
21+### 3. Enter the group shortcode
22
22
23We’ll start by joining Urbit Community, a friendly introductory Urbit group.
23We’ll start by joining Urbit Community, a friendly introductory Urbit group.
24
24
@@ -29,7 +29,7 @@ Then confirm by clicking with the second “Join Group” button.
29![](https://media.urbit.org/site/group/groups-guide2.png)
29![](https://media.urbit.org/site/group/groups-guide2.png)
30![](https://media.urbit.org/site/group/groups-guide3.png)
30![](https://media.urbit.org/site/group/groups-guide3.png)
31
31
32−## 4. Confirm join
32+### 4. Confirm join
33
33
34You should see a window that provides a description and group information. If not, check the spelling of the group name and address and try again.
34You should see a window that provides a description and group information. If not, check the spelling of the group name and address and try again.
35
35
@@ -39,7 +39,7 @@ Click "Join Urbit Community".
39
39
40![](https://media.urbit.org/site/group/groups-guide4.png)
40![](https://media.urbit.org/site/group/groups-guide4.png)
41
41
42−## 5. Join channels
42+### 5. Join channels
43
43
44Congratulations, if you’re seeing a window like the one that appears below then you’ve joined the group!
44Congratulations, if you’re seeing a window like the one that appears below then you’ve joined the group!
45
45
@@ -50,6 +50,6 @@ To join a channel within the group, select a channel name from the left column,
50![](https://media.urbit.org/site/group/groups-guide5.png)
50![](https://media.urbit.org/site/group/groups-guide5.png)
51![](https://media.urbit.org/site/group/groups-guide6.png)
51![](https://media.urbit.org/site/group/groups-guide6.png)
52
52
53−## 6. Chat and post on the network
53+### 6. Chat and post on the network
54
54
55Congratulations you’re now a part of a peer-to-peer Urbit group. Be friendly, be curious, and have fun.
55Congratulations you’re now a part of a peer-to-peer Urbit group. Be friendly, be curious, and have fun.
content/getting-started/server.md+7−7
@@ -4,7 +4,7 @@ description = "Run urbit on a local or cloud server"
4weight = 2
4weight = 2
5+++
5+++
6
6
7−### Get yourself a planet
7+### 1. Get yourself a planet
8
8
9Here's some of the hard fun work we talked about earlier.
9Here's some of the hard fun work we talked about earlier.
10
10
@@ -18,7 +18,7 @@ Visit the instructions for [launching a temporary comet with Port](/getting-star
18
18
19There are many markets and individuals selling planets such as [azimuth.shop](https://azimuth.shop), [Networked Subject](https://subject.network), and [Wexpert Systems](https://wexpert.systems) for Ethereum, Bitcoin, and USD respectively.
19There are many markets and individuals selling planets such as [azimuth.shop](https://azimuth.shop), [Networked Subject](https://subject.network), and [Wexpert Systems](https://wexpert.systems) for Ethereum, Bitcoin, and USD respectively.
20
20
21−<div className="bg-wall-100 p-4 rounded-xl" style="padding-bottom: 1rem;">
21+<div className="bg-wall-100 p-7 rounded-xl markdown-callout">
22
22
23**Layer 1 vs Layer 2 planet purchasing**
23**Layer 1 vs Layer 2 planet purchasing**
24
24
@@ -28,7 +28,7 @@ For this reason we generally advise using a L2 planet market, unless you are int
28
28
29</div>
29</div>
30
30
31−### Claim your planet
31+### 2. Claim your planet
32
32
33An invitation to claim your planet comes in one of two forms.
33An invitation to claim your planet comes in one of two forms.
34
34
@@ -40,7 +40,7 @@ The second, only recently made available through our [L2 solution](/getting-star
40
40
41Clicking a link to activate a planet on Bridge will take you to page which will generate a Master Ticket for you. Follow the instructions which will prompt you to download a copy of your Passport - your Master Ticket, management proxy, and keyfile. Store your Master Ticket and management proxy somewhere safe, hold on to the keyfile, and proceed to the next step.
41Clicking a link to activate a planet on Bridge will take you to page which will generate a Master Ticket for you. Follow the instructions which will prompt you to download a copy of your Passport - your Master Ticket, management proxy, and keyfile. Store your Master Ticket and management proxy somewhere safe, hold on to the keyfile, and proceed to the next step.
42
42
43−<div className="bg-wall-100 p-4 rounded-xl" style="padding-bottom: 1rem;">
43+<div className="bg-wall-100 p-7 rounded-xl markdown-callout">
44
44
45**Claiming L1 planets**
45**Claiming L1 planets**
46
46
@@ -48,7 +48,7 @@ If you’ve purchased an L1 planet, you won’t need to claim it because you alr
48
48
49</div>
49</div>
50
50
51−### Use Bridge to get your keyfile
51+### 3. Use Bridge to get your keyfile
52
52
53Now that you have your planet, you can create your keyfile (eg. `sample-palnet.key`), which is the cryptographic signature required to encrypt and decrypt messages on Urbit's P2P network.
53Now that you have your planet, you can create your keyfile (eg. `sample-palnet.key`), which is the cryptographic signature required to encrypt and decrypt messages on Urbit's P2P network.
54
54
@@ -138,7 +138,7 @@ Arvo, the Urbit OS, now creates a directory called `sampel-palnet/` and begins b
138
138
139Welcome to Urbit! You can skip ahead to [log in](#log-in), or stick around for some tips.
139Welcome to Urbit! You can skip ahead to [log in](#log-in), or stick around for some tips.
140
140
141−### Tips
141+### 4. Tips
142
142
143Check out the [cloud hosting guide](/using/running/hosting) for tips on improving the environment for Urbit, with a particular focus on establishing your domain name and using SSL for encryption.
143Check out the [cloud hosting guide](/using/running/hosting) for tips on improving the environment for Urbit, with a particular focus on establishing your domain name and using SSL for encryption.
144
144
@@ -154,7 +154,7 @@ You should also delete your keyfile from your remote system to prevent yourself
154rm ./your-keyfile.key
154rm ./your-keyfile.key
155```
155```
156
156
157−### Log in
157+### 5. Log in
158
158
159First, use your browser to navigate to the URL+port where your ship is running. This could be an IP address or a fully-qualified domain name, depending on how you set yours up.
159First, use your browser to navigate to the URL+port where your ship is running. This could be an IP address or a fully-qualified domain name, depending on how you set yours up.
160
160
styles/markdown.css+6
@@ -39,6 +39,12 @@
39 @apply text-base md:text-lg leading-relaxed;
39 @apply text-base md:text-lg leading-relaxed;
40}
40}
41
41
42+.markdown-callout p {
43+ @apply mt-1;
44+ @apply mb-2;
45+ font-size: 1rem;
46+}
47+
42.markdown li {
48.markdown li {
43 @apply py-2 ml-6 text-base md:text-lg;
49 @apply py-2 ml-6 text-base md:text-lg;
44}
50}