Editing the wiki - sparklabnyc/resources GitHub Wiki

This page provides guidelines for contributing to and editing the lab wiki. Please update and contribute to the wiki!

Getting permission and access

  • If you are part of the lab, please feel free to edit, but please be responsible
  • Confirm that you have GitHub editing access or ask for it

Accessing the wiki

  • You can edit the wiki either by:
    • Direct editing on GitHub wiki interface
    • Forking the wiki repository and submitting a PR

Editing the wiki

  • Editing directly (better for smaller updates)
    • Navigate to the wiki tab in the resource repository.
    • Open the page you want to edit and click the edit button in the upper right of the page.
    • Use the built-in Markdown editor to make changes.
    • Preview your edits and save when ready.
    • More information on editing and adding pages to GitHub wikis is available from GitHub
  • Editing via forking (better if you want to review or are unsure of changes)

Set up GitHub on your machine first if you haven't already done so.

1. Fork the wiki repository

  • Go to the main repository on GitHub.
  • Click fork (top right).
  • This creates your own copy under your GitHub account.

2. Make edits in your fork

  • Navigate to the wiki tab in your forked repository.
  • Open the page you want to edit.
  • Click the edit (pencil) button at the top right.
  • Make your changes using the built-in Markdown editor.
  • Preview your edits and click save page.

3. Create a Pull Request (PR)

  • After you finish your edits, go to the Pull Requests tab on your fork’s main page.
  • Click New Pull Request.
  • GitHub will compare your fork to the main repository.
  • Submit the PR for review.

Once approved, your changes will be merged into the main wiki!

Learning Markdown

Simple Markdown tutorial

Markdown is supposed to be an easy, readable, and lightweight language, so the best way to learn is to try!

  • Use # for section headers.# through ###### get progressively smaller.
  • Use - for bullet points. You can add spaces before them to indent.
  • Use [text](link) to link somewhere, like another website.
  • Use [text](page name) to link to other pages and [page-name#section-name](/sparklabnyc/resources/wiki/page-name#section-name) to link to a specific section.
  • Use backticks `text` to get monospaced text with a gray background
  • You can also make code/text blocks by using three backticks (```)
  • Here’s a more comprehensive resource for understanding Markdown syntax: Markdown Cheatsheet

Important notes

  • Avoid deleting significant content without prior notice.
  • Always proofread your edits
  • Always back up important pages before making large edits.
  • Keep the wiki updated and accurate for all lab members.