https://github.com/solide-project/polposal
proposaling new resource and content for POL
https://github.com/solide-project/polposal
Last synced: 4 months ago
JSON representation
proposaling new resource and content for POL
- Host: GitHub
- URL: https://github.com/solide-project/polposal
- Owner: solide-project
- Created: 2024-09-29T06:52:28.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-17T10:41:51.000Z (about 1 year ago)
- Last Synced: 2025-04-13T01:30:02.186Z (about 1 year ago)
- Language: TypeScript
- Size: 41 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Proof of Learn Resource Proposals
This repository is designed to enable creators to contribute educational resources to the Proof of Learn (POL) platform. POL empowers learners by providing interactive, blockchain-certified learning experiences. By following the outlined process, creators can stake, validate, and publish their resources, which will be rewarded with POL POAP NFT badges and become part of the broader educational ecosystem. The goal is to make quality learning materials accessible while ensuring their authenticity through blockchain verification.
## Prerequisite
To add a resource to POAP, the repository must comply with the following template structure:
- **`content` folder**: This folder contains all the Markdown content related to the resource.
- **`poap` folder**: This folder holds the metadata and the POL POAP NFT badge art.
- **`quest.config.json`**: A configuration file that defines the structure and details of the quest.
Ensure that your repository adheres to this template to successfully integrate with POAP.
## Creating a new proposal
Use this repo to create a proposal (GitHub Issue) that will allow the community and POL to confirm the resource and content on the POL platform
1. **Create a Repository**
Start by creating a GitHub repository containing the resource. Ensure it adheres to the required template structure outlined in the prerequisites.
2. **Stake on POL**
Stake 10 OC (Open Campus token) on the POL contract and record the **transaction hash**. This stake is necessary to verify your commitment to the platform.
3. **Create an Issue**
Open a GitHub issue in the repository for the resource. This issue will serve as a tracking tool for the validation process.
4. **Stage 1: In Progress**
- The issue will be labeled as `in progress` in this stage.
- A POL member will review the resource to validate its authenticity and ensure it is accessible and complete. The community can also contribute during this stage to determine if the resource should be accepted into POL.
- The recorded **transaction hash** will be verified automatically by an action to confirm the staking.
5. **Validation and Completion**
- If the resource passes the validation, the issue will be updated to `completed` status. It will remain open for a certain period (X hours) to allow for further community review.
- Once the review period concludes, closing the issue with the `complete` label will trigger an action that stores the resource metadata on POL, making it accessible on the platform.
By following this process, your resource will become part of the Proof of Learn (POL) ecosystem.
## Status Terms
TODO
---
# More technical
Given a repository, for example - https://github.com/5208980/pol-template
### Pre Checks
We'll need to submit an issue with the title of repo. It'll run `pre:quest` base of the repo provided. This validates, the quest.config.json. To ensure that all the information is valid for storing.
### Staking
Once that passes, we can ask for staking. This is provided as a **transaction hash**, and
### Manual Verification
The next step is a manually process, where the community and the team will. The issue will also be tagged as `in progress`.
Verification will involve,
- Content in resournce is correct and safe to be shown on POL
- Quests in `quest.config.json` is accessible for everything to submit
- If POAP is available, then include POAP image and metadata to store on chain.
### Adding to POL
After successful manual verification, the issue will be tagged as `completed`. This means that the team as close the issue, and when that happens. The pipeline will run `post:poap` to store information about the POAP on IPFS and on chain
---
v2
- test:pre:quest - Validate your poap
- test:post:poap - Upload poap metadata to IPFS and add URI to contract
- test:post:store - Add questing and information to DB
- test:post:update - Updates. Will overwrite existing