Skip to content

Update README.md #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 15, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updating README
  • Loading branch information
toshimaru committed May 15, 2019
commit 73d28f5086385a6c1c68e6e5edb82f525954eb5c
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).