oss-fuzz/docs
R. Elliott Childre d70f793353
Delete unnecessary files and fix format in some MD pages (#4115)
* style: Clean up the repo

* Bolster the `.gitignore`
* Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80
  characters and seperate links for readability
* Remove pesky Unicode dash in `CONTRIBUTING.md`
* Remove `.DS_STORE` files
* Rename `#project.yaml#` to something logical and enable stntax
  highlighting

* Updates from reviewers

* Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim
  temporary files
* Apply markdown style to `docs/index.md`
* small comma grammatical change

* http -> https
2020-07-16 15:27:29 -07:00
..
advanced-topics Updated reproducing.md (#4013) 2020-06-20 08:31:59 -07:00
further-reading Updated fuzzer_environment.md (#4009) 2020-06-18 08:21:49 -07:00
getting-started Add CIFuzz documentation on how to run jobs on certain branches, paths (#4113) 2020-07-13 14:50:16 -07:00
images Change arrows to ovals (#3386) 2020-02-13 16:21:52 -08:00
oss-fuzz [docs] Replace "furthur" with "further" throughout the documentation. (#2737) 2019-08-21 15:10:15 -07:00
reference [docs] Link the general definition of the fuzz target on the reference page (fixes #2148). (#3602) 2020-04-08 22:27:04 -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 [docs] Add FAQ entry regarding forked repos + bump the bundler version. (#4078) 2020-07-07 09:22:05 -07:00
README.md Documentation fixes. (#2705) 2019-08-15 15:07:23 -07:00
_config.yml Add jekyll generator for docs. (#2660) 2019-08-06 13:29:19 -07:00
faq.md [docs] Add FAQ entry regarding forked repos + bump the bundler version. (#4078) 2020-07-07 09:22:05 -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 Delete unnecessary files and fix format in some MD pages (#4115) 2020-07-16 15:27:29 -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 install --path vendor/bundle

Serving locally

$ bundle exec jekyll serve

Theme documentation

We are using the just the docs theme.