-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(docs.lumeweb.com): move to vocs and revamp docs, add portal …
…user and operator docs
- Loading branch information
Showing
33 changed files
with
955 additions
and
593 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
"@lumeweb/docs.lumeweb.com": minor | ||
--- | ||
|
||
move to vocs and revamp docs, add portal user and operator docs |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,60 @@ | ||
import React from 'react' | ||
|
||
interface Activity { | ||
icon: string | ||
title: string | ||
description: string | ||
} | ||
|
||
interface Quarter { | ||
quarter: string | ||
focusArea: string | ||
activities: Activity[] | ||
} | ||
|
||
interface RoadmapSection { | ||
year: string | ||
quarters: Quarter[] | ||
} | ||
|
||
const RoadmapTable: React.FC<{section: RoadmapSection}> = ({section}) => { | ||
return ( | ||
<div className="my-12"> | ||
<h2 className="text-3xl font-bold mb-6">{section.year}</h2> | ||
<div className="overflow-x-auto"> | ||
<table className="w-full border-collapse bg-[var(--vocs-color-background2)] border border-[var(--vocs-color-border)]"> | ||
<thead> | ||
<tr> | ||
<th className="p-5 text-left font-bold bg-[var(--vocs-color-background)] border border-[var(--vocs-color-border)] text-lg">Quarter</th> | ||
<th className="p-5 text-left font-bold bg-[var(--vocs-color-background)] border border-[var(--vocs-color-border)] text-lg">Focus Area</th> | ||
<th className="p-5 text-left font-bold bg-[var(--vocs-color-background)] border border-[var(--vocs-color-border)] text-lg">Activities</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
{section.quarters.map((quarter, i) => ( | ||
<tr key={i} className="hover:bg-[var(--vocs-color-background)]"> | ||
<td className="p-5 border border-[var(--vocs-color-border)] w-24 whitespace-nowrap align-top font-medium">{quarter.quarter}</td> | ||
<td className="p-5 border border-[var(--vocs-color-border)] w-48 align-top font-medium">{quarter.focusArea}</td> | ||
<td className="p-5 border border-[var(--vocs-color-border)]"> | ||
<ul className="space-y-4"> | ||
{quarter.activities.map((activity, j) => ( | ||
<li key={j} className="flex items-start gap-4"> | ||
<span className="flex-shrink-0 w-8 text-center text-xl">{activity.icon}</span> | ||
<span className="flex-1"> | ||
<strong className="text-[var(--vocs-color-textAccent)] mr-2 font-bold">{activity.title}</strong> | ||
{activity.description} | ||
</span> | ||
</li> | ||
))} | ||
</ul> | ||
</td> | ||
</tr> | ||
))} | ||
</tbody> | ||
</table> | ||
</div> | ||
</div> | ||
) | ||
} | ||
|
||
export default RoadmapTable |
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
layout: landing | ||
--- | ||
|
||
import { HomePage } from 'vocs/components' | ||
|
||
<HomePage.Root> | ||
<HomePage.Logo /> | ||
<HomePage.Tagline>Freedom. Privacy. Ownership.</HomePage.Tagline> | ||
<HomePage.Description> | ||
Lume is building a hybrid portal service that aims to improve web access through P2P technology, | ||
while operating within legal frameworks. We're working towards greater online freedom and data ownership | ||
through decentralized technologies. | ||
</HomePage.Description> | ||
|
||
## Key Features | ||
|
||
- 🌐 **Censorship Resistant**: Access content freely across decentralized networks without restrictions | ||
- 🔒 **Privacy First**: Your data remains yours - no tracking, just pure P2P technology | ||
- ⚡ **Easy to Use**: Simple gateway access to Web3 - no complex setup needed | ||
|
||
<HomePage.Buttons> | ||
<HomePage.Button href="/intro/getting-started" variant="accent">Get Started</HomePage.Button> | ||
<HomePage.Button href="https://github.com/lumeweb">GitHub</HomePage.Button> | ||
</HomePage.Buttons> | ||
</HomePage.Root> |
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
29 changes: 29 additions & 0 deletions
29
apps/docs.lumeweb.com/docs/pages/intro/getting-started.mdx
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 |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Getting Started with Lume | ||
|
||
We believe in building practical solutions for a more open internet. That's why we're creating tools that bridge traditional and decentralized technologies. | ||
|
||
## Who is Lume For? | ||
|
||
We're focused on users who: | ||
- Value privacy and digital freedom | ||
- Want more control over their online experience | ||
- Are interested in Web3 but need practical solutions, or just want better privacy and data ownership | ||
- Believe in supporting sustainable, community-driven development | ||
|
||
## What We Offer | ||
|
||
Here's what we're building: | ||
- A portal service that makes Web3 accessible today | ||
- Privacy-respecting infrastructure that balances innovation with sustainability | ||
- Tools that work within current systems while pushing toward decentralization | ||
- Community-funded development of public goods technology | ||
|
||
We're taking a balanced approach - building real Web3 infrastructure while ensuring our services are reliable and sustainable. This means some compromises today, but always with the goal of expanding digital freedom tomorrow. | ||
|
||
## Next Steps | ||
|
||
1. [Check out our roadmap](/roadmap) to see our vision | ||
2. Join our community (coming soon) | ||
3. Start using the portal (launch details coming Q1 2024) | ||
|
||
Want to learn more about our approach? Check out [What is Lume?](/intro/about) |
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 |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
title: Operating a Portal | ||
--- | ||
|
||
# Operating a Portal | ||
|
||
## Introduction | ||
|
||
Running a Lume Portal means providing gateway access to decentralized networks. You can run a portal for: | ||
- Private use within your organization | ||
- Public access as a community service | ||
- Development and testing | ||
|
||
Each portal contributes to the broader network of decentralized access points. | ||
|
||
## Base Requirements | ||
|
||
### Software | ||
- Linux (Ubuntu 22.04 LTS recommended) | ||
- Go 1.23+ | ||
- Docker (optional but recommended) | ||
|
||
### Network | ||
- Public IP address | ||
- Port 443 for HTTPS access | ||
- Additional ports opened based on enabled plugins (documented per plugin) | ||
|
||
### Hardware | ||
- 4 CPU cores | ||
- 8GB RAM | ||
- 20GB SSD storage for base system | ||
|
||
### Database | ||
- SQLite by default (good for most deployments) | ||
- MySQL/PostgreSQL optional for larger deployments | ||
|
||
The portal is designed to start small and scale up. You can begin with these base requirements and expand resources as your needs grow. | ||
|
||
## Plugin Considerations | ||
|
||
Each plugin has different resource needs. We recommend starting with 1-2 plugins and monitoring resource usage before enabling more. | ||
|
||
## Planning Your Deployment | ||
|
||
Before setting up your portal: | ||
|
||
1. **Choose Your Plugins** | ||
- Decide which protocols to support | ||
- Review each plugin's requirements | ||
- Plan for resource needs | ||
|
||
2. **Consider Your Users** | ||
- Private or public access | ||
- Expected usage patterns | ||
- Access controls needed | ||
|
||
3. **Basic Security** | ||
- Network security | ||
- Access management | ||
- Update procedures | ||
|
||
Ready to install? Continue to our [Setup Guide](/operators/setup). |
Oops, something went wrong.