Codex Protocol Documentation
Clone or download
Pull request Compare This branch is 67 commits ahead of lord:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
source
.gitignore
.travis.yml
Gemfile
Gemfile.lock
LICENSE
README.md
Vagrantfile
config.rb
deploy.sh
font-selection.json
package.json

README.md

Codex Protocol | Codex API Documentation (site.dev-codexprotocol-com)

standard-readme compliant

Codex API documentation built with Slate

This repository contains source code for The Codex API documentation hosted on https://dev.codexprotocol.com.

Table of Contents

Install

This documentation is built with Slate, which requires some prerequisites for development:

  • Linux or macOS — Windows may work, but is unsupported.
  • Ruby, version 2.3.1 or newer
  • Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Usage

After prerequisites have been installed, you can initialize and start Slate. You can either do this locally, or with Vagrant:

# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

After you make markdown changes, you can deploy change by running ./deploy. For more information see Slate's deployment documentation.

Maintainers

Contribute

If you have any questions, feel free to reach out to one of the repository maintainers or simply open an issue here on GitHub. If you have questions about Codex Protocol in general, feel free to reach out to us Telegram!

Pull Requests are not only allowed, but highly encouraged! All Pull Requests must pass CI checks (if applicable) and be approved by at least one repository maintainer before being considered for merge.

Codex Labs, Inc follows the Contributor Covenant Code of Conduct.

License

Apache License 2.0 © Codex Labs, Inc