- Doctor is a Documentation Server for all your project docs.
- Doctor beautifully decouples document serving and document contents.
- Create your docs in markdown. Store them anywhere (github/dropbox/google drive/ anywhere really).
- Login to Doctor's Dashboard. Setup links to your doc files in Doctor's Dashboard.
- You are done!
- Install Ruby 2.2.2 using the instructions here.
- Install Rails 4.2.4 using the instructions here.
- Install Postgres using the command
brew install postgres
. Configure Launch Agent to start it automatically or use the commandpg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start
to start it manually.
Note - Ping us on our gitter channel to report any installation issues on your platform.
> git clone https://github.com/minio/doctor.git
> cd doctor
> bundle install
> rake db:create
> rake db:migrate
> rake db:seed
> rails s
Now visit http://localhost:3000
- Documents are organized under Categories.
- Login to the dashboard
- Use the Dashboard or Create a new Category : http://localhost:3000/category/new
- Use the Dashboard Create a new Document : http://localhost:3000/document/new
- Required : All documents need to be associated under a Category