Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Proof Read and Improve Amber Docs #63

Open
2 of 29 tasks
elorest opened this issue Jan 12, 2018 · 7 comments
Open
2 of 29 tasks

Proof Read and Improve Amber Docs #63

elorest opened this issue Jan 12, 2018 · 7 comments
Labels
status:help-wanted status:wip

Comments

@elorest
Copy link
Member

elorest commented Jan 12, 2018 •
edited by eliasjpr
Loading

Our guides have come a long ways but I still find grammatical and spelling mistakes when I read through them.

Review and improve Amber Docs and Checkoff:

GETTING STARTED

  • Quick Start

GUIDES

  • Overview
  • Installation
  • Directory Structure
  • Configuration
  • Routing
  • Controllers
  • Models
  • Views
  • Mailers
  • Websockets

TESTING

  • System Tests
  • Controller Tests
  • Integration Tests
  • Model Testing

DEPLOYMENT

  • Deploying To Heroku
  • Deploying To Digital Ocean

COMMAND LINE INTERFACE

  • Amber CLI
  • New
  • Generate
  • Database
  • Exec
  • Deploy
  • Encrypt
  • Routes
  • Watch

EXAMPLES

  • Amber Auth Example
  • VS Code Debugging
  • Crecto ORM
@robacarp
Copy link
Member

I just did a Amber Auth Example check and a pull was merged today

@elorest
Copy link
Member Author

elorest commented Jan 13, 2018

Thanks. I checked it off.

@faustinoaq
Copy link
Contributor

Interesting comment here: https://github.com/amberframework/online-docs/pull/74#discussion_r178726690 (improve user experience)

@faustinoaq
Copy link
Contributor

We're using https://amberframework.gitbook.io/amber/ now 🎉

@faustinoaq
Copy link
Contributor

screenshot_20180516_000748

I updated the new Gitbook to match the Table of Contents @elorest published here 👍

Please, Take a look 👉 https://amberframework.gitbook.io/amber/

@aquaflamingo aquaflamingo mentioned this issue Apr 29, 2021
Merged
@aquaflamingo
Copy link
Contributor

See #183 for guides/config

eliasjpr pushed a commit that referenced this issue May 1, 2021
@aquaflamingo
#63 Cleans up Configuration Docs (#183)
663e3bd 
* Cleans up guides/configuration grammer and organization

* Moves environments above initializers in docs

* Fixes grammar about AMBER_ENV in initializers

* Nit picky verb usage
@aquaflamingo aquaflamingo mentioned this issue May 1, 2021
Merged
eliasjpr pushed a commit that referenced this issue May 3, 2021
@aquaflamingo
#63 Proof reads and rewords Overview section (#184)
ff5afb9 
* Proof reads and rewords overview section

* Additional rewording and consolidating

* One more pass through
@aquaflamingo aquaflamingo mentioned this issue May 5, 2021
Merged
@aquaflamingo
Copy link
Contributor

#184 covers overview
#185 covers directory structure, installation, overview, guides/routing, guides/routes

eliasjpr pushed a commit that referenced this issue May 9, 2021
@aquaflamingo
#63 Update Jennifer Docs (#186)
013394c 
* Updates base models README

* Updates jennifer/README

* Updates jennifer/model

* Jennifer/migrations

* Additional pass through
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status:help-wanted status:wip
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@elorest @robacarp @faustinoaq @aquaflamingo