Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 2.84 KB

README.md

File metadata and controls

87 lines (59 loc) · 2.84 KB
Raw
title description published date tags editor dateCreated
README
true
2024-09-29 17:16:23 UTC
markdown
2024-09-26 19:04:38 UTC

Wiki-js

Introduction

This project is a Wiki created and managed by the volunteer Community of RealT investors. It was created on the occasion of the launch of the RealToken DAO to complement the existing documentation and offer more flexibility and contribution possibilities to the entire community.

Objective

The main objective of this Wiki is to test a solution (Wiki.js) that should offer more flexibility and contribution possibilities for the entire community compared to the existing solution (Gitbook).

Content

Currently, the Wiki mainly focuses on the RealToken DAO. The first articles therefore concern the DAO and are created here as a test. If this approach proves successful, other topics will follow.

Project Structure

The project is organized into several language folders, with a similar structure for each language:

  • /fr: French content
  • /es: Spanish content
  • /pt: Portuguese content
  • /: English content (default language)

Each language folder contains:

  • A home.md file that serves as the Wiki's homepage,
  • A DAO.md file for specific DAO information,
  • A Tuto.md file for initiating Wiki contributors,
  • An notes_Admin.html file for specific Wiki Admin notes,
  • A folder for each topic:
    • DAO containing pages related to the RealToken DAO,
    • Tuto containing help pages for Wiki contributors
  • An assets folder containing images and other resources used in the Wiki.
  • A documents folder containing PDF documents and others linked to Wiki pages.

How to Contribute to the Wiki Content

Contributions to this Wiki are welcome. Here's how you can participate:

From Github

  1. Carefully read the existing content,
  2. Propose modifications or additions via pull requests,
  3. Participate in discussions on existing articles,
  4. Suggest new topics to cover.

From the Wiki

  1. Create an account on the Wiki,
  2. Request to join the team of contributors,
  3. Click on the "Edit" button at the top right,
  4. Make your modifications,
  5. Click on "Save" at the top right,
  6. Your modification is sent to the Admin team who will validate it and add it to the online version.

How to Contribute to the Wiki Code

Attention: the Wiki code is not yet available on the community's github.

  1. Fork the repo,
  2. Create a new branch,
  3. Make your modifications,
  4. Make a PR to the original repo.

Feedback

Your feedback and contributions are valuable for improving this Wiki. Don't hesitate to open issues to report problems or suggest improvements.

License

MIT

Contact

For any questions or suggestions, please contact the development team via GitHub issues or the RealToken community communication channels.