Add help for generators #1107
Open
Add help for generators #1107
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Goal: provide users with better website help for Loco generators. Context: The Loco guide website has help files for models, views, controllers, etc., but not (yet) for generators. In my opinion, generators are awesome and are a good way for novices to create Loco apps quickly and correctly. loco-rs#1094 This commit is a rough draft of a Loco guide help page. Ideally other people here can use this as a starting point for adding more help, better help, good examples, etc. For me personally, this page as-is (presuming there are no showstopper errors) would be a big help for teaching Loco to teammates, even given the page is a rough draft. I tried to use a similar TOML front matter; please can someone on the team could proof that? The Rails guides have a much more sophisticated geneators guide. IMHO worth a read. In my Rails work, my teams often use custom generators, and always use custom field types defined in a migration helper class, such as `email = string(254)` and `latitude = numeric(12,9)`. with '#' will be ignored, and an empty message aborts the commit. # # Date: Thu Dec 26 15:43:19 2024 -0800 # # On branch add-help-for-generators # Changes to be committed: # new file: docs-site/content/docs/the-app/generators.md #
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal: provide users with better website help for Loco generators.
Context: The Loco guide website has help files for models, views,
controllers, etc., but not (yet) for generators. In my opinion,
generators are awesome and are a good way for novices to create Loco
apps quickly and correctly.
Helps with #1094
This commit is a rough draft of a Loco guide help page. Ideally other
people here can use this as a starting point for adding more help,
better help, good examples, etc.
For me personally, this page as-is (presuming there are no showstopper
errors) would be a big help for teaching Loco to teammates, even given
the page is a rough draft.
I tried to use a similar TOML front matter; please can someone on the
team could proof that?
The Rails guides have a much more sophisticated geneators guide. IMHO
worth a read. In my Rails work, my teams often use custom generators,
and always use custom field types defined in a migration helper class,
such as
email = string(254)andlatitude = numeric(12,9).