Skip to content
This repository was archived by the owner on Mar 1, 2025. It is now read-only.

Commit 5bf4b1b

Browse files
prokoudinepatdavid
andauthored
Docs, next batch (#144)
* Add some initial docs * Add initial barebone docs for organizations, workspaces, account settings etc. * docs: add sidebar_position to pages frontmatter * Basic upload docs * Add a section on exploring models * Add a placeholder for the Model Customization section * Docs reorganization * Docs reorganization, new sections * Drop the old docs structure * Add rewritten Overview page * Add a section on uploading and sharing * Add the initial Key Concepts section * Clean up front matter and update sidebar position for upload & share * Update sidebar positions again * Add getting embed code page * Add Explore 3D CAD models page * Add a short new concepts page on slugs * Minor tweak for the explore page * Add the section on hierarchy, accounts, orgs, and workspaces * Change the page id * Harmonize title cases * Fix broken links --------- Co-authored-by: Pat David <[email protected]>
1 parent 608c5e5 commit 5bf4b1b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+884
-13
lines changed
846 KB
Loading
719 KB
Loading
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
id: account-settings
3+
title: Account Settings
4+
description: Changing settings specific to you Ondsel Lens account
5+
tags:
6+
- account
7+
sidebar_position: 2
8+
---
9+
10+
## Accessing the settings
11+
12+
There are two ways to access account settings:
13+
14+
1. Click on the **3 dot icon** located at the bottom of the sidebar. Then, select **Account Settings**.
15+
16+
![Snapshot](go-to-settings-1.gif)
17+
18+
---
19+
20+
2. Alternatively, navigate to the top of the sidebar, click on the organization name, then click on the **gear** icon of your personal organization.
21+
22+
![Snapshot](go-to-settings-2.gif)
23+
24+
---
25+
26+
All account settings are divided into three parts.
27+
28+
## Public Details
29+
30+
These are the settings that are visible to other user and anonymous visitors:
31+
32+
- **Name**. This is your real name that you specified when registering. To edit it, click the 'CHANGE NAME' button to the right.
33+
- **Username**. This is the unique name used in your public account's URL.
34+
- **Short description**.
35+
- **Long description**.
36+
- **Tags**.
37+
- **Links**.
38+
- **Public page**. This is the link to your public profile that you can share.
39+
40+
## Private Details
41+
42+
These are the settings that no other user except you can know:
43+
44+
- **Email**. The email address you used for registering with Lens.
45+
- **Password**. Your current password masked by asterisk symbols for security reasons. To change the password, click the 'RESET PASSWORD' button to the right. Lens will ask your confirmation to send an email with a unique link for resetting the password.
46+
47+
## Account
48+
49+
The only setting here is **Current Tier**. You can see what tier you are currently on, change it, and view account history.
50+
51+
To change your tier, click the 'CHOOSE NEW TIER' button. You will be taken to the page that lists existing tiers. You can upgrade from Solo to Peer or downgrade from Peer to Solo, in which case all your private models will become public.
52+
53+
You can also view the entire history of your account: when you joined and when you switched to various tiers. To do that, click the 'VIEW ACCOUNT HISTORY' button.
54+
55+
## Organization Membership
56+
57+
This settings page lists all organizations you are part of and allows creating a new organization.
58+
59+
For each organization, you can set email notifications: whether Lens should send you an email every time you receive a notification on the system.
60+
61+
## Public Promoted Items
62+
63+
This settings page lists all the share links, users, organization, and workspaces that you recommended, along with a complent comment for each (where available).
64+
65+
For more information about promoted items, please see the **Promotions** page.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
id: hierarchy
3+
title: Hierarchy
4+
description: The hierarchy of accounts, organizations, and workspaces
5+
tags:
6+
- account
7+
- organization
8+
- workspace
9+
sidebar_position: 1
10+
---
11+
12+
Lens follows a straightforward model where a user creates an organization, adds new members, then creates workspaces, and adds members of the parent organization to workspaces.
13+
14+
Thus, in the project hierarchy, the user who created the organization is automatically assigned the role of the organization owner, is given admin priveleges, and has the power to manage the organization and its workspaces.

docs/account-team/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
id: account-team
3+
title: Account & Team
4+
description: How to manage accounts, organizations, and teams
5+
tags:
6+
- account
7+
- organization
8+
- workspace
9+
sidebar_position: 5
10+
---
11+
12+
This section explain how to create new organizations, add team members, create and manage workspaces.
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
id: create-new-org
3+
title: Creating a New Organization
4+
description: How to create a new organization in Ondsel Lens
5+
tags:
6+
- organizations
7+
sidebar_position: 2
8+
---
9+
10+
This guide will explain creating a new open or private organization on Ondsel Lens.
11+
12+
---
13+
14+
1. To start creating a new organization, click on the three dots icon at the bottom of the sidebar where your account name is.
15+
16+
![Snapshot](step-01.gif)
17+
18+
---
19+
20+
2. Click on **Account Settings**.
21+
22+
![Snapshot](step-02.gif)
23+
24+
---
25+
26+
3. On the **Account Settings** page, switch to the **Organization Memberships** tab.
27+
28+
![Snapshot](step-03.gif)
29+
30+
---
31+
32+
4. Click the **Create Organization** button.
33+
34+
![Snapshot](step-04.gif)
35+
36+
---
37+
38+
5. Select the **Type of Organization**, open or private.
39+
40+
![Snapshot](step-05.gif)
41+
42+
---
43+
44+
6. Type the **Name** of the organization.
45+
46+
![Snapshot](step-06.gif)
47+
48+
---
49+
50+
7. Then, type the organization's **Slug**, a variation of its name used in its URL on Lens.
51+
52+
![Snapshot](step-07.gif)
53+
54+
---
55+
56+
8. Now click on **Create** to finalize creating a new organization.
57+
58+
![Snapshot](step-08.gif)
59+
60+
---
61+
62+
This will create a new organization and open its settings for editing.
63+
64+
![Settings of a newly created organization](new-org-settings.png)
264 KB
Loading
509 KB
Loading
492 KB
Loading
515 KB
Loading

0 commit comments

Comments
 (0)