oss-fuzz/docs
jonathanmetzman af2617d7d0
[ClusterFuzzLite][docs] Start writing docs (#6165)
I started writing some important docs, such as overview, build_integration, and running_clusterfuzzlite. However, most important docs are still TODO.
This PR at least adds a skeleton for those docs.
2021-08-05 12:01:07 -07:00
..
advanced-topics [docs] Mention JVM & Go coverage support (#5826) 2021-05-25 07:30:21 -07:00
clusterfuzzlite [ClusterFuzzLite][docs] Start writing docs (#6165) 2021-08-05 12:01:07 -07:00
further-reading Fix typos and one link (#5645) 2021-04-20 15:46:16 -07:00
getting-started [docs] Enable AWT headless mode in Java guide (#6155) 2021-08-04 10:18:09 +01:00
images Change arrows to ovals (#3386) 2020-02-13 16:21:52 -08:00
oss-fuzz Fix typos and one link (#5645) 2021-04-20 15:46:16 -07:00
reference Fix typos and one link (#5645) 2021-04-20 15:46:16 -07:00
.gitignore Add jekyll generator for docs. (#2660) 2019-08-06 13:29:19 -07:00
404.html Add jekyll generator for docs. (#2660) 2019-08-06 13:29:19 -07:00
Gemfile Add jekyll generator for docs. (#2660) 2019-08-06 13:29:19 -07:00
Gemfile.lock Reinstall jekyll deps to update kramdown version in Gemfile.lock (#6168) 2021-08-04 20:51:07 -07:00
README.md [docs][NFC] Don't rely on deprecated flag to silence warning. (#6164) 2021-08-04 08:19:11 -07:00
_config.yml Add jekyll generator for docs. (#2660) 2019-08-06 13:29:19 -07:00
faq.md Clarify in the new project guide that pull_images may be needed for coverage runs. (#5506) 2021-03-25 07:43:18 -07:00
favicon.ico Add jekyll generator for docs. (#2660) 2019-08-06 13:29:19 -07:00
glossary.md Documentation fixes. (#2705) 2019-08-15 15:07:23 -07:00
ideal_integration.md Update ideal_integration.md 2019-08-22 11:28:24 -07:00
index.md Update index.md 2021-06-05 19:21:15 -07:00
new_project_guide.md Documentation fixes. (#2705) 2019-08-15 15:07:23 -07:00
reproducing.md Add redirect for old reproducing.md (#2666) 2019-08-07 12:57:10 -07:00

README.md

Readme

Use the following instructions to make documentation changes locally.

Prerequisites

$ sudo apt install ruby bundler
$ bundle config set path 'vendor/bundle'
$ bundle install

Serving locally

$ bundle exec jekyll serve

Theme documentation

We are using the just the docs theme.