Skip to main content

Wiki Contributions

Introduction​

Introduction

https://github.com/BotWithUs/BwuWiki
  • Our wiki is completely open source, you can find the code here.
  • This wiki is a NodeJS project, which means you can run the code locally yourself, all while it updates in real time in your local browser once you save files.
  • The minimum supported NodeJS Version is 18
  • All wiki pages are Markdown files, and are all found in the docs/ folder of the github repo.
  • Docusaurus leverages the MDX Compiler to transform markdown syntax into React components, amazing!
  • See Docussaurus Markdown Features to become a pro at making beautiful pages.
You can help!

If you'd like to contriubute, you can by making a pull request to our master branch!

Getting setup​

Getting setup

  • First, let's make sure that you have NodeJS 18+ installed.
  • Then, install yarn, the package manager for this project:
    Install yarn package manager
npm install --global yarn
  • Next, you'll need to make sure that you have Git or GitHub Desktop installed.
  • Then, clone our code using GitHub Desktop, or run the following commands:
    Clone the Wiki repository
git clone https://github.com/BotWithUs/BwuWiki
cd BwuWiki
Before proceeding

You should make a new branch as you cannot commit changes to master. Or you can fork the repository. If you make a bunch of changes to the locally checked out master branch, you wont be able to push them to the repo.

  • Next, inside of the BwuWiki folder, run the following command to install dependencies:
    Install project dependencies
yarn
  • Now you are all set to run the project locally!
  • The following command will launch the project locally and connect you to it via your browser.
    Its local dev time baby!
yarn start
Changes reflect instantly!

While the server is running, any changes you make to files and save, should reflect live in your local browser.

Making your changes live​

Making your changes live

Best wiki editing practices​

Best wiki editing practices

Clarity and Conciseness:​

  • Write in a clear and concise manner to enhance readability.
  • Break down complex information into easily understandable sections.

Structure and Formatting:​

  • Follow the established structure and formatting guidelines of the wiki.
  • Use headers, bullet points, and other formatting tools to organize content effectively.

Avoid Plagiarism:​

  • Always create original content or properly attribute the source if using someone else's work.
  • Respect copyright laws and the intellectual property of others.

User-Friendly Language:​

  • Write in a way that is accessible to a wide audience, avoiding jargon or overly technical language when unnecessary.

Regular Updates:​

  • Keep information up-to-date by revisiting and editing content periodically.
  • Add new information and remove outdated or irrelevant details.