From 0d93993723bd8758eb228b7ad1635da12e7c3745 Mon Sep 17 00:00:00 2001 From: toshimaru Date: Wed, 8 May 2019 06:17:17 +0900 Subject: [PATCH 1/3] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 693a02cc5f..0076e80e8e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ # [railsdoc.github.io](https://railsdoc.github.io/) [![Build Status](https://travis-ci.com/railsdoc/railsdoc.github.io.svg?branch=page-source)](https://travis-ci.com/railsdoc/railsdoc.github.io) + +railsdoc.github.io is yet another Rails API documentation website. + +## Project Goal + +The project goal is **making [api.rubyonrails.org](https://api.rubyonrails.org/) SEO-friendly**. From 73d28f5086385a6c1c68e6e5edb82f525954eb5c Mon Sep 17 00:00:00 2001 From: toshimaru Date: Wed, 15 May 2019 12:12:33 +0900 Subject: [PATCH 2/3] Updating README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 0076e80e8e..d64b897aa7 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,19 @@ railsdoc.github.io is yet another Rails API documentation website. ## Project Goal The project goal is **making [api.rubyonrails.org](https://api.rubyonrails.org/) SEO-friendly**. + +### Additional Goals + +Thare are some enhancements in addition to SEO. + +- [ ] Powered by [Jekyll](TODO:link) +- [ ] Styled by [bootstrap](TODO:link) +- [ ] No iframe +- [ ] Mobile-friendly webpage +- [ ] Table of Contents +- [ ] Google Custom Search +- [ ] etc. (see. https://github.com/railsdoc/railsdoc.github.io/issues) + +## Feature Request + +Please create an [issue](https://github.com/railsdoc/railsdoc.github.io/issues). From 5d420f09586b60b3205a36a429dd22522fee9e47 Mon Sep 17 00:00:00 2001 From: toshimaru Date: Wed, 15 May 2019 19:57:41 +0900 Subject: [PATCH 3/3] Update link --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d64b897aa7..16a3eeb869 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,13 @@ The project goal is **making [api.rubyonrails.org](https://api.rubyonrails.org/) Thare are some enhancements in addition to SEO. -- [ ] Powered by [Jekyll](TODO:link) -- [ ] Styled by [bootstrap](TODO:link) -- [ ] No iframe -- [ ] Mobile-friendly webpage -- [ ] Table of Contents -- [ ] Google Custom Search +- [x] Built by [Jekyll](https://github.com/jekyll/jekyll) +- [x] Styled by [bootstrap(v4)](https://github.com/twbs/bootstrap) +- [x] No iframe layout +- [x] Table of Contents +- [x] Google Custom Search +- [ ] Mobile-friendly design +- [ ] Multiple version documentation - [ ] etc. (see. https://github.com/railsdoc/railsdoc.github.io/issues) ## Feature Request