Linearize ASG among other improvements by cb341 · Pull Request #442 · renuo/application-setup-guide

cb341 · 2026-04-22T14:58:29Z

Linearize the guide so setup reads top-to-bottom without backtracking and drop stuff along the way.

As this is primarily a refactoring for mdbook, I advise reviewers to check
http://localhost:3000/ and https://open-source.renuo.ch/application-setup-guide/ side by side.

lukasbischof

Thanks for your efforts to optimise this guides, I think it's nice to streamline the process a bit and I like the new structure 👍

lukasbischof · 2026-04-23T12:03:25Z

-* Continuous deployment (*CD*) ready and running for both branches
-* The application deployed for both branches
-
-As an appendix, you'll find a [checklist](checklist.md) you can use to follow the guide.


No more checklist?

coorasse

Nice work.
There some parts that I'd like to keep for historical reasons and some rephrasings I do not approve, but overall the changes are good. Can you please extract the emoji changes in a separate PR? They have nothing to do with the rest and we can get them merged separately. Some separate things (an agent will do this for you in a minute):

mdbook changes and fixes (also make sure the readme command works)
emojis
warnings,notes,and other sections normalized with github formatting
content

I'd like this PR to contain only the changes to the actual content, so I can review the last two files. Thanks!

cb341 · 2026-04-30T13:16:07Z

+Scans `Gemfile.lock` for gems with known security vulnerabilities. Add it to the `bin/fastcheck` script:
+
+```sh
+bundle exec bundler-audit check --update


Maybe we don't need to include the bundler-audit in the fastcheck..

cb341 · 2026-04-30T13:19:50Z

Refactored this as we don't adhere to gitflow we find inspiration in it.
It is a pretty central concept that gives background on how the git repo is setup.

I'd keep it in the ASG and not rely solely on the wiki.renuo.ch

Restructure the docs so the guide reads as a single sequential walkthrough, and fold in the related content updates the restructure surfaced. Linearization (the spine of the change): - Top-level README: replace the single "Ruby on Rails" link with a four-phase "How to Use This Guide" roadmap; drop the outdated "Some Notes on the Side" intro, the "As an appendix" sentence, the "We want you to know..." line and the "Thank you" outro; reorder the "Do not blindly follow" and "challenge the guide" callouts up front; promote the basic-requirements bullet list to a "## What Needs to Be Ready" section. - SUMMARY: regroup pages under Before You Start / Rails Application Setup (Step 1–5) / Guides & Recipes / Services / Reference. Move `Create a GitHub Repository` into Step 1, split the Setup section into Step 1 (Create the App) and Step 2 (Deploy the App), add `AppSignal` to Step 4 and `Wallee Payment` / `Content Security Policy` / `I18n` to Guides & Recipes; move `Checklist`, `Go Live!` and the templates under Reference. - ruby_on_rails/README: insert `## Step 1: Create the App` … `## Step 5: Customer Plan Services` and `## Guides & Recipes` around the existing lists; switch the Guides & Recipes list from ordered to bulleted with an intro line that flags it as non-sequential; add a `> 💡 **Tip:**` block explaining the ✨ convention; insert `---` separators around Guides & Recipes; drop the dead `[README](compile_readme.md)` link and the redundant "Some services should be configured accordingly..." preamble. Content updates the linearization surfaced: - Drop the now-dead `ruby_on_rails/compile_readme.md` page. - Drop the broken `home_controller.rb` reference in cucumber.md that the RSpec template never shipped. - `first_git_push.md`: rewrite to acknowledge that `rails new` already creates the local git repo and initial commit; link back to the previous step instead of the file path. - `create_application_server_deploio.md`: shorten the "For further configuration" paragraph and surface the Rails guide first. - `configure_git_repository.md`: rewrite the Rules/Rulesets block around a `main` / `non-main` split (covers feature branches and long-living branches like `redesign`), reorder the Pull Requests checklist to match the GitHub UI, drop the trailing long-living-environment note (now redundant), drop the `(AFTER SETTING UP SEMAPHORE)` aside. - `create_git_repository.md`: rename the page title from "Create a Git Repository" to "Create a GitHub Repository" to match the new SUMMARY entry. - `linting_and_automatic_check.md`: add `> ✨` template-supplied markers to Renuocop and Brakeman, add a new Bundler-audit section, drop the now-redundant "It's already included in your Gemfile by default" line. - `rspec.md`: add a `> **Note:**` block clarifying that the Renuo Rails template does NOT set up RSpec. - `app_initialisation.md`: add `# may vary` comments on the example `time_zone` / `default_locale` values; switch the example `config.generators.apply_rubocop_autocorrect_after_generate!` line to the Rails 8 block form; rewrite the final "commit all your changes" bullet to "you're ready for the next step". No prose / formatting / emoji changes here — those live in feature/docs-phrasing and feature/emoji-cleanup. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

cb341 self-assigned this Apr 22, 2026