git.iko.soy/urbit.org
on master help sign in
copy updates, styling updates
commit4465475044cf96b8071e306458ecf5c77ce56976 authorGordon <gordon@hey.com> dateTue 24 Jan 2023, 14:04 (4 years ago) parent3e285df
8 files changed+114−74
compare with master
unifiedsplit
components/DocsSidebar.js+1−1 content/getting-started/_index.md+2−8 content/getting-started/free-trial.md−11 content/getting-started/getting-around.md+51 content/getting-started/installing-applications.md+17−17 content/getting-started/joining-groups.md+18−12 content/getting-started/self-host.md+14−12 pages/getting-started/[[...slug]].js+11−13
components/DocsSidebar.js+1−1
@@ -9,7 +9,7 @@ export default function Sidebar(props) {
99 <div className="hidden md:flex flex-col w-96 bg-wall-100 max-h-screen h-screen">
1010 <header className="flex shrink-0 justify-between items-center pl-6 pt-12 mt-5 pb-8">
1111 <Link href="/" passHref>
12− <a className="type-ui text-wall-500">Urbit</a>
12+ <a className="font-semibold antialiased text-lg text-wall-500">Urbit</a>
1313 </Link>
1414 </header>
1515 <div className="overflow-y-auto p-6 pt-16">
content/getting-started/_index.md+2−8
@@ -4,8 +4,6 @@ weight = 0
44description = ""
55+++
66
7−*These documents are intended to show you how to use Urbit. They'll guide you through the various options and give you enough context to find your way around. If dont know what Urbit is, you might want to read the [Overview](https://urbit.org/overview) first.*
8−
97The goal of Urbit is to make peer-to-peer software easy for developers to write
108and for users to run on their own. The code is [completely open
119source](https://github.com/urbit), [actively
@@ -13,12 +11,8 @@ maintained](https://github.com/urbit/urbit/graphs/code-frequency), supported by
1311a [growing ecosystem](https://urbit.org/ecosystem), and [used daily by
1412thousands](https://network.urbit.org).
1513
16−The Urbit software stack consists of two high-level components: an operating
17−system (Urbit OS) and an identity system (Urbit ID). If Urbit OS were a door,
18−Urbit ID would be the key that unlocks it; the former requires the latter.
19−
20−Urbit OS enables its user to communicate directly with others using Urbit OS via
21−their Urbit ID's. You can think of these like phone numbers &mdash; meaningless
14+Urbit consists of two high-level components: an operating
15+system (Urbit OS) and an identity system (Urbit ID). Urbit OS enables its user to communicate directly with others using Urbit OS via their Urbit ID's. You can think of these like phone numbers &mdash; meaningless
2216but memorizable, and likely to identify the same person reliably through time.
2317
2418Using Urbit requires having access to a running **ship**: an Urbit OS running
content/getting-started/free-trial.mddeleted−11
@@ -1,11 +0,0 @@
1−+++
2−title = "Free Trial"
3−weight = 1
4−description = "One day of a free Urbit to check things out."
5−tag = "hostprov"
6−+++
7−
8−The Urbit Foundation provides free Urbit hosting for one day for a limited
9−number of people per day.
10−
11−TODO:
content/getting-started/getting-around.mdnew file+51
@@ -0,0 +1,51 @@
1++++
2+title = "Getting around"
3+description = "Get around your urbit"
4+tags = "around"
5+weight = 1
6++++
7+
8+
9+
10+
11+### 1. Get oriented
12+
13+After you've logged into your Urbit for the first time, you'll see what we call Landscape – an interface for interacting with the network and applications. You'll also see a few pre-installed applications: Terminal, Groups, and Talk. More on them in a moment.
14+
15+Above those are buttons to view System Preferences and check out notifications for messages and application activity. The search bar helps you surface applications you already have installed, or discover developers and applications across the Urbit network.
16+
17+You'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+
19+### 2. Join a few groups
20+
21+Joining public groups is simple – just search for the group host's Urbit ID, and click join. Check out a walk-through of this process in the [Joining groups](/getting-around/joining-groups) guide.
22+
23+### 3. Get more Urbit apps
24+
25+Groups are great, but Urbit goes way deeper with apps that are developed specifically for Urbit and use P2P networking for everything.
26+
27+Check out the [Installing apps](/getting-around/installing-applications) guide for a walk-through on the process of installing Urbit applications.
28+
29+
30+### 4. Get help
31+
32+If 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.
33+
34+That community isn't for every support request, however. If your question involves an app, you're better served reaching out to the developer — for example, if you have an issue with EScape's notifications feature, reach out to Uqbar in [`~hocwyn-tipwex/uqbar-event-horizon`](/groups/~hocwyn-tipwex/uqbar-event-horizon).
35+
36+If you're having trouble with your planet or the hosting provider that's running your ship, try their support, as they'll have more context and resources to help solve your issue.
37+
38+And 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.
39+
40+
41+
42+### 5. What's next?
43+
44+
45+**Learn more about using Urbit**: Check out the [Operators Site](https://operators.urbit.org/) to learn more about running your own Urbit and how the network functions.
46+
47+**Get updates about Urbit**: [Subscribe](https://urbit.us11.list-manage.com/subscribe/post?u=972a03db9e0c6c25bb58de8c8&id=be143888d2) to the Urbit Newsletter for news, blog posts, and events from the Urbit Foundation.
48+
49+**Join an event or meetup**: Many of the organizations and people behind Urbit host virtual and in-person events on a regular basis — check out the latest on our [Events feed](/events/), or a local [Meetup group](/ecosystem?type=communities).
50+
51+**Learn how to build on Urbit**: If you're the kind of person who wants to build applications directly for discerning communities with built-in identity and networking primitives, or even jump into the Urbit kernel's core, we have the most comprehensive information to get you started on the [Urbit Developers Site](https://developers.urbit.org/).
content/getting-started/installing-applications.md+17−17
@@ -1,39 +1,39 @@
11+++
22title = "Installing apps"
33tag = "around"
4−weight = 1
4+weight = 3
55+++
66
7−### 1. Get on the network
7+Installing urbit applications is very simple. Just search for the developer, and download the application. We'll walk you through it.
88
9−First, you’ll need to get on Urbit.
9+### 1. Finding applications
1010
11−Check out our [Getting Started guide](https://urbit.org/install) to find the best way for you.
11+To get an application, you'll need to know its developer Urbit ID, *e.g.* `~tirrel` or `~dister-fabnev-hinmur`, or the full Urbit address, *e.g.* `~tirrel/studio`.
1212
13−### 2. Finding applications
13+This information is available applications in the [Applications directory](/ecosystem?type=applications) in the Ecosystem section of urbit.org.
1414
15−Urbit 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.
15+Urbit is still in its early stages and not all applications are listed on urbit.org, so you’ll need to join groups and browse around the network to discover the newest applications as they are being brought up.
1616
17−However, we can get started a simple app from Urbit developer [`~paldev`](/ids/~paldev).
17+However, we can get started a simple app from Urbit developer [`~tirrel`](/ids/~tirrel).
1818
19−### 3. Search for a Developer
19+### 2. Search for a Developer
2020
21−Once 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.
21+Once you’re on the network, you’ll see a large tiled interface with a few applications and a search bar on the top of the page.
2222
2323Click and the search bar and search for the software provider’s Urbit ID.
2424
25−For example, to install the picture application, search for `~paldev` and then click on the result for `~paldev` to show his applications.
25+For example, to install the Studio application, search for `~tirrel` and then click on the result for `~tirrel` to show the applications.
2626
27−![](https://media.urbit.org/site/additional-guides/Installing-apps-1.jpg)
27+![](https://media.urbit.org/site/additional-guides/apps-1.png)
2828
29−![](https://media.urbit.org/site/additional-guides/Installing-apps-2.jpg)
29+![](https://media.urbit.org/site/additional-guides/apps-2.png)
3030
31−### 4. Get the Application
31+### 3. Get the Application
3232
33−After 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.
33+Select the Studio app, and a modal window 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.
3434
35−Soon you’ll have a new application tile on your home screen that will let you upload and display a picture to your home screen.
35+Soon you’ll have a new application tile on your home screen that will let you host a blog from your urbit.
3636
37−![](https://media.urbit.org/site/additional-guides/Installing-apps-3.jpg)
37+![](https://media.urbit.org/site/additional-guides/apps-3.png)
3838
39−![](https://media.urbit.org/site/additional-guides/Installing-apps-4.jpg)
39+![](https://media.urbit.org/site/additional-guides/apps-4.png)
content/getting-started/joining-groups.md+18−12
@@ -4,21 +4,28 @@ tag = "around"
44weight = 2
55+++
66
7−### 1. Get on the network
7+Joining public groups is straightforward: search for the group host's Urbit ID, and join.
88
9−First, you’ll need to get on Urbit.
9+Some groups are private, so you'll need approval to join.
1010
11−Check out our [Getting Started guide](https://urbit.org/install) to find the best way for you.
11+And still other groups are secret! Which means you can't find them, and you'll need to be invited to join.
1212
13−### 2. Open the Groups app
13+Let's walk through the process of finding and joining a public group.
1414
15−Once you’re on the network, you’ll see and large tiled interface with a few applications installed: Talk, Terminal, Groups, and Bitcoin. Click on Groups.
15+
16+### 1. Open the Groups app
17+
18+Once you’re on the network, you’ll see Landscape, which is filled with large applications tiles: Talk, Terminal, and Groups. Click on Groups.
1619
1720![](https://media.urbit.org/site/additional-guides/groups-1.png)
1821
19−### 3. Enter the group shortcode
22+### 2. Enter the group shortcode
23+
24+To join a group, you'll need to know its host Urbit ID (e.g. ~bitbet-bolbel) or its full Urbit address, also called a shortcode.
25+
26+Check out some public groups in the [urbit.org groups directory](/ecosystem?type=groups)
2027
21−We’ll start by joining UF, the official group of the Urbit Foundation.
28+As an example, we’ll start by joining UF, the official group of the Urbit Foundation.
2229
2330In the Groups app, click on "Find Groups" in the left column and enter `~halbex-palheb/uf-public`
2431
@@ -26,9 +33,10 @@ Then click on the "Join" button once the group appears.
2633
2734![](https://media.urbit.org/site/additional-guides/groups-2.png)
2835
29−### 4. Join channels
3036
31−Now, you'll see the first default channel of the group.
37+### 3. Join channels
38+
39+Give it a minute and you'll see the first default channel of the group. For some larger groups with a large backlog, such as Urbit Community, this may require for than a minute.
3240
3341![](https://media.urbit.org/site/additional-guides/groups-3.png)
3442
@@ -39,12 +47,10 @@ We can join more channels in the group by clicking on the "All Channels" link in
3947
4048
4149
42−### 5. Chat and post on the network
50+### 4. Chat and post on the network
4351
4452In addition to posting text, you can now react, start threads, and reference messages by hovering over chat messages. And you can leave comments in notebooks if they are enabled.
4553
4654Remember to be nice, and have fun.
4755
4856![](https://media.urbit.org/site/additional-guides/groups-4.png)
49−
50−
content/getting-started/self-host.md+14−12
@@ -5,18 +5,6 @@ description = ""
55tag = "selfhost"
66+++
77
8−TODO
9−
10−- Brief bit about technical architecture, since audience is technical
11−- To start, read about the different types of ID
12−- Choose where to run Urbit.
13−- On your local computer is good for experimentation, but not long-term usage
14− because you want it to run as a server.
15−- Can start local and move to a cloud hosting or home server, or start with
16− either of the latter options
17−- Tradeoff: ownership over data and ID, ongoing maintenance costs
18−
19−NOTES
208
219To run Urbit on your own you need to be comfortable using a command line
2210interface (CLI), and should have a basic understanding of how to interact with
@@ -26,3 +14,17 @@ Urbit OS is comprised of a virtual operating system (Arvo) and a runtime called
2614(Vere). The runtime has official versions targeting Linux and macOS, although
2715workarounds exist for Windows.
2816
17+Running Urbit locally is good for experimentation, but in the long term you'll want to run it as you a server — always on, and accessible from anywhere. The nice thing about Urbit is that's easy to start local, and later move to cloud hosting or home server. Or you can start with the latter options.
18+
19+Remember, never run your Urbit in more than one place! Doing so will likely necessitate a [factory reset](https://operators.urbit.org/manual/id/guide-to-resets).
20+
21+## Next Steps
22+
23+1. [Get an Urbit ID](/getting-started/get-id):
24+You can boot Urbit with a comet, a temporary Urbit ID, but you'll want a planet so you can take full advantage of the networked experience.
25+
26+2. [CLI instructions](/getting-started/cli):
27+Set up Vere, the Urbit runtime, using the command line.
28+
29+3. [Install on the cloud](/getting-started/cloud-hosting):
30+A step-by-step guide to setting up Urbit on Digital Ocean.
pages/getting-started/[[...slug]].js+11−13
@@ -44,7 +44,7 @@ export default function UsingLayout({ posts, data, params, search, markdown }) {
4444 hostprov.sort((a, b) => a.weight > b.weight);
4545 around.sort((a, b) => a.weight > b.weight);
4646
47− const rootClasses = "pl-0 font-semibold text-base hover:text-green-400";
47+ const rootClasses = "pl-0 font-semibold antialiased text-base hover:text-green-400";
4848
4949 return (
5050 <>
@@ -54,7 +54,7 @@ export default function UsingLayout({ posts, data, params, search, markdown }) {
5454 </Head>
5555 <div className="flex h-screen min-h-screen w-screen sidebar">
5656 <Sidebar search={search}>
57− <p className="uppercase pb-1 font-bold text-xs text-wall-400">
57+ <p className="uppercase pb-1 font-bold antialiased text-xs text-wall-400">
5858 Getting Started
5959 </p>
6060 <ul>
@@ -68,9 +68,9 @@ export default function UsingLayout({ posts, data, params, search, markdown }) {
6868 </li>
6969 ))}
7070 </ul>
71− <ul className="mt-8">
72− <p className="uppercase pb-1 font-bold text-xs text-wall-400">
73− Run Yourself (Technical)
71+ <ul className="mt-6">
72+ <p className="uppercase pb-1 font-bold antialiased text-xs text-wall-400">
73+ Run Yourself
7474 </p>
7575 {selfhost.map((post) => (
7676 <li>
@@ -82,9 +82,9 @@ export default function UsingLayout({ posts, data, params, search, markdown }) {
8282 </li>
8383 ))}
8484 </ul>
85− <ul className="mt-8">
86− <p className="uppercase pb-1 font-bold text-xs text-wall-400">
87− Hosting Services (Non-technical)
85+ <ul className="mt-6">
86+ <p className="uppercase pb-1 font-bold antialiased text-xs text-wall-400">
87+ Hosting Services
8888 </p>
8989 {hostprov.map((post) => (
9090 <li>
@@ -96,8 +96,8 @@ export default function UsingLayout({ posts, data, params, search, markdown }) {
9696 </li>
9797 ))}
9898 </ul>
99− <ul className="mt-8">
100− <p className="uppercase pb-1 font-bold text-xs text-wall-400">
99+ <ul className="mt-6">
100+ <p className="uppercase pb-1 font-bold antialiased text-xs text-wall-400">
101101 Getting Around
102102 </p>
103103 {around.map((post) => (
@@ -132,9 +132,7 @@ export default function UsingLayout({ posts, data, params, search, markdown }) {
132132
133133const breadcrumbs = (posts, paths) => {
134134 const results = [
135− <Link href="/">Urbit</Link>,
136− <span className="px-1">/</span>,
137− <Link href="/getting-started">Getting Started</Link>,
135+ <Link href="/getting-started">Getting Started</Link>
138136 ];
139137 let thisLink = "/getting-started";
140138 for (const path of paths) {