motor-admin-rails VS YARD

I think the coolest thing about Rails is actually the great amount of high quality Ruby gems for Rails.

For instance, you can bootstrap a powerful Admin panel for your Rails project in no time with https://github.com/motor-admin/motor-admin-rails gem.

You should try https://github.com/motor-admin/motor-admin-rails - it builds admin UI with basic CRUD on top of AR models automatically. Unlike other gems where ruby code is required Motor Admin panel can be customized via settings directly in the UI - all configurations are stored in motor.yml file and can be easily transferred between environments.

https://github.com/motor-admin/motor-admin-rails - just adding a link here. u/dpaluy motor admin doesn't require any integration with your rails app js build stack (doesn't depend on webpack/esbuild) - due to that it's very easy to integrate it with any existing app.

1. Use git to create commits with new configurations in motor.yml and deploy/pull that git repo on the production host in order to update the configs.

2. MOTOR_SYNC_REMOTE_URL=https://remote-app-url/ MOTOR_SYNC_API_KEY=secure-random-string rake motor:sync to sync configurations directly to production app host via API.

There a bit of info about configurations sync between environment here:

https://github.com/motor-admin/motor-admin-rails#configurati...

You should try https://github.com/motor-admin/motor-admin-rails This admin panel gem doesn't use DSL or configuration files and can be customized directly via the UI. More complex things like custom forms and actions can be added via regular rails API controllers.

User roles and permissions via CanCan (learn more).

u/PikachuEXE authorization with row/column level permissions via cancan has been implemented in the newest release - https://github.com/omohokcoj/motor-admin#authorization

JSDOC is a predefined method of documenting code for javascript ecosystem created in 1999 that works similar to libraries for other languages such as: Javadoc for java, YARD for ruby, etc..

In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.

I still just document everything using YARD and focus on designing really obvious Object Models and of course write tests. I have tried using sord to convert my YARD type annotations to RBS or RBI, but you still have to fill in missing bits, then use steep and somehow load in RBS/RBI files for other gems and stdlib, and it's just an uphill battle since Ruby is dynamically typed by default. Obviously Dynamic Typing lends itself more to Dynamic Languages, where you can call an arbitrary method and let the language VM figure it out at runtime. Static or Strong Typing lends itself better to compiled languages where everything needs to be resolved at compile time and converted into object code. If I need to work in a compiled language, then I'll use Crystal, which also supports type inference. TypeScript's type syntax is quite nice, but I tend to avoid writing massive JavaScript code bases where a Type Checker helps catch subtle bugs, and instead prefer sticking to minimal amounts of vanilla JavaScriot in order to keep complexity low and not overwhelm the browser.

I had a dig into the file history, and it looks like we have to go back to 0.7 to find the old tag list. Here we find the info we need to understand the intent of the @option tag:

YARD: http://yardoc.org/

I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.

That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.).

My first assumption was, that I should be able to generate markdown from the source. Same ruby and rails does now, but only tweaking a couple of parameters to generate .md files instead. YARD is being used for that and it supports any markup rdoc or yard.

I’ve long used the YARD format and chose to use that as my documentation syntax. I suppose I didn’t check with anyone on this decision and slowly started adding documentation. I want to use this post to synthesize my implicit decision and the benefits of using Yard as the documentation format.

That said, YARD is a ruby documentation tool that has a yard graph command you can use to dump a UML graph for your app into a .dot file, which can be used with lots of different graphing tools (usually graphviz but there are a bunch of online tools and open source projects that can visualize them for you).