mirror of
https://github.com/privacy-scaling-explorations/pse.dev.git
synced 2026-04-23 03:01:03 -04:00
fix documentation
This commit is contained in:
@@ -15,7 +15,7 @@ Enhancing Ethereum through cryptographic research and collective experimentation
|
||||
|
||||
### Add/Edit project list
|
||||
|
||||
- For updating/adding project detail [you can follow this guide](content/projects/_README.md)
|
||||
- For updating/adding project detail [you can follow this guide](content/projects/README.md)
|
||||
|
||||
## PR Review process
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ tldr: "Brief project summary" # Short description of the project
|
||||
# ========================================
|
||||
# OPTIONAL PROPERTIES - Remove if not needed
|
||||
# ========================================
|
||||
category: "research" # Project category: "research" | "applications" | "devtools"
|
||||
category: "research" # Project category: "research" | "devtools" | "application"
|
||||
license: "MIT" # Project license
|
||||
tags: # Project tags
|
||||
keywords: ["tag1", "tag2", "tag3"] # Relevant keywords
|
||||
@@ -67,7 +67,7 @@ Your project content goes here using **Markdown** formatting.
|
||||
|
||||
**Optional Properties:**
|
||||
|
||||
- `category`: Project type ("research", "applications", "devtools")
|
||||
- `category`: Project type ("research", "devtools", "application")
|
||||
- `license`: Project license (e.g., "MIT", "Apache-2.0")
|
||||
- `hasWiki`: Boolean for wiki page template
|
||||
- `youtubeLinks`: Array of YouTube video URLs
|
||||
@@ -84,6 +84,12 @@ That's it! Your new project will now be visible in the projects list.
|
||||
- `inactive`: Not actively maintained
|
||||
- `maintained`: Stable, receiving updates as needed
|
||||
|
||||
## Project Categories
|
||||
|
||||
- `research`: Research-focused projects
|
||||
- `devtools`: Developer tools and utilities
|
||||
- `application`: Application projects
|
||||
|
||||
## Project Sections
|
||||
|
||||
- `pse`: Privacy & Scaling Explorations projects
|
||||
|
||||
Reference in New Issue
Block a user