Skip to content

Linearize ASG among other improvements#442

Draft
cb341 wants to merge 1 commit into
mainfrom
feature/improve-docs
Draft

Linearize ASG among other improvements#442
cb341 wants to merge 1 commit into
mainfrom
feature/improve-docs

Conversation

@cb341
Copy link
Copy Markdown
Contributor

@cb341 cb341 commented Apr 22, 2026

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.

@cb341 cb341 self-assigned this Apr 22, 2026
Comment thread bin/mdbook-rewrite-links Outdated
Comment thread ruby_on_rails/configure_ci.md
Comment thread ruby_on_rails/create_application_server_deploio.md Outdated
Comment thread ruby_on_rails/devise.md
Comment thread ruby_on_rails/wallee.md
Comment thread SUMMARY.md
@cb341 cb341 changed the title Linearize ASG Linearize ASG + other improvements Apr 22, 2026
@cb341 cb341 marked this pull request as ready for review April 22, 2026 21:47
@cb341 cb341 changed the title Linearize ASG + other improvements Linearize ASG among other improvements Apr 22, 2026
@cb341 cb341 requested a review from lukasbischof April 23, 2026 08:55
Copy link
Copy Markdown
Member

@lukasbischof lukasbischof left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 👍

Comment thread ruby_on_rails/app_initialisation.md
Comment thread ruby_on_rails/first_git_push.md
Comment thread ruby_on_rails/README.md
Comment thread ruby_on_rails/README.md
Comment thread bin/mdbook-rewrite-links Outdated
Comment thread README.md
Comment thread README.md
Comment thread SUMMARY.md
Comment thread SUMMARY.md
@cb341 cb341 requested a review from coorasse April 23, 2026 14:01
Copy link
Copy Markdown
Member

@coorasse coorasse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Comment thread ruby_on_rails/app_initialisation.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread ruby_on_rails/depfu.md
Comment thread ruby_on_rails/devise.md
Comment thread ruby_on_rails/first_git_push.md
Comment thread ruby_on_rails/first_git_push.md
Comment thread ruby_on_rails/hotjar.md
@cb341 cb341 marked this pull request as draft April 29, 2026 15:26
@cb341 cb341 force-pushed the feature/improve-docs branch 2 times, most recently from 9384c0e to fd20e49 Compare April 30, 2026 13:10
@cb341 cb341 marked this pull request as ready for review April 30, 2026 13:11
@cb341 cb341 marked this pull request as draft April 30, 2026 13:11
Scans `Gemfile.lock` for gems with known security vulnerabilities. Add it to the `bin/fastcheck` script:

```sh
bundle exec bundler-audit check --update
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread branching_model.md Outdated
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread naming_conventions.md Outdated
@cb341 cb341 force-pushed the feature/improve-docs branch from e576be3 to f9fa4de Compare April 30, 2026 15:05
- Linearize Application Setup Guide into sequential numbered steps
- Refresh Bootstrap recipe and Wicked PDF instructions
- Update README, SUMMARY, naming conventions
- Various phrasing and formatting cleanups across guides
- Update Gitlab hint, mdbook command examples
- Add template-repo comments to Rails docs

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@cb341 cb341 force-pushed the feature/improve-docs branch from f9fa4de to de963c5 Compare May 6, 2026 06:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants