Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 3.68 KB

README.md

File metadata and controls

65 lines (40 loc) · 3.68 KB
Raw

Portal Speedrun Guide

Portal (2007)

Contributing

In order to contribute, you at least need a GitHub account. This is a requirement so that you can create a fork of the repository, add your changes, and submit a pull request.

From there, you have a few different options for contributing.

Development

The easiest way to contribute if you are not familiar with git or don't want to install anything is to use the remote development.

There are a few important files and directories to know about when contributing;

  • docs - This is where all the guide content is stored, aside from assets.
  • static - This is where images, videos, and other assets are stored.
  • config.yml - This is the configuration file that stores the guide's metadata, layout information, et cetera.
  • .backend - This folder houses all Docusaurus configuration and build files. Do not modify anything in here unless you know what you are doing.

Remote Development with StackBlitz

At the time of writing, this is behaving a bit strangely. If you are having issues, please try the local development method.

You can use StackBlitz web-based editor and link your GitHub account to it. From here, you will have access to a web version of Visual Studio Code, where you can edit the files and see a preview update in real time.

  1. In the top right, click Fork to create a fork of the repository. This will create a copy of the repository in your account. Alternatively, you can click here to create a fork.

  2. Visit https://pr.new/github/<your username>/<name of fork> to open the StackBlitz web editor with your fork. For example, if your username is speedrun-guide and your fork is named portal, you would visit https://pr.new/github/speedrun-guide/portal.

  3. From here, you can edit the files and see a preview update in real time. When you're done, you can push the changes to your fork, then submit a pull request. You can also create a pull request directly from within the editor by navigating to Source Control on the left side.

Local Development

Local development can have a few benefits, but also a few more steps. Those benefits include faster preview and build times, as well as the ability to use your own editor, like WebStorm or Vim.

  1. Clone the project using git clone https://github.com/speedrun-guide/portal. If you don't have git installed, learn how to here.

  2. Install Node.js.

  3. Run npm run dev in the project directory in a terminal. localhost:3000 should automatically open in your browser and provide you a live updating preview.

Once you've followed all of these steps, you can edit the guide and see your changes in real time.

Pull Request

Once you've made your changes, you can submit a pull request to the main repository. This will allow the verified maintainers to review your changes and merge them into the main repository.

Please write meaningful PR messages describing all the changes you've made. If you are adding a new section, please include a description of the section and what it covers.

PRs that modify anything in .backend are incredibly likely to be rejected, unless you have a very, very good reason.