README.md

open.inf.is Documentation

Warning

This documentation is still in draft stage. All information may be incomplete, inaccurate, outdated, or even completely wrong.

Note

If one is using VS Code, it is recommended to use the provided devcontainer available via the official Remote Development extension.

One may skip dependency installation in this case.

Install Dependencies

Install the necessary dependencies for the documentation site by running this command from the project workspace root (if necessary):

pnpm install

# Configure Bundler setting local gem install path to avoid permission errors.
bundle config set --local path vendor/bundle
# Install the dependencies specified in the Gemfile.
bundle install

Running Locally

One can preview contributions before opening a pull request.

Run this from within the project workspace root directory:

nps start

Once the script finishes building the documentation site, one may visit it at http://localhost:4000.

Scripts

To lint all files, run this from the project workspace root:

nps verify.all

To autofix all files, run this from the project workspace root:

nps format.all

To build for production (or preview), run this from the project workspace root:

nps build

License

© The OpenINF Authors & Friends. Content licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.