Amber: Document amber codebase

[faustinoaq]

Description

Document all of the amber codebase to be compatible with crystal docs and generate a nice web api page

Steps to Reproduce

Not applicable (feature request)

Versions

Master https://github.com/amberframework/amber/commit/bea1063f640e0c7466989fd50cd0453b812d7a39

Additional Information

We can host the new api page on amberframework.org/api as well :+1:

[irlcatgirl]

@faustinoaq What can contributors do to help with this effort? I have some experience with technical writing and this task may be up my ally. I know Crystal has the docs generation command, where can I read up on the syntax of method and module comment docs? What's been done already (if anything) concerning this issue.

[eliasjpr]

@nsuchy the amber community will be for ever in debt to you if you accomplish this! Here is the crystal guide for documenting code. https://crystal-lang.org/reference/conventions/documenting_code.html

[elorest]

I couldn't agree more.

[andrewc910]

Just tried looking into this. The error i got was:

In src/amber/cli/templates/api/controller/spec/controllers/spec_helper.cr:1:1

 1 | require "../spec_helper"
     ^
Error: can't find file '../spec_helper' relative to '/home/andrew/workspace/crystal/amber/src/amber/cli/templates/api/controller/spec/controllers/spec_helper.cr'

It get started on this, it looks like A LOT of files in the cli templates section will have to become .cr.ecr files. Is the core team okay with this? I can make a PR about changing over the necessary files to get crystal docs to build. There won't be much as the code itself isn't documented well but at least step 1 would be in progress.

[eliasjpr]

This is a great step very much needed. :medal_military: @andrewc910