openrewrite / rewrite-docs

Stores the markdown documents used to generate docs.openrewrite.org
https://docs.openrewrite.org
Apache License 2.0
41 stars 52 forks source link

FAQ Entry on "How do I remove an element from the LST?" #290

Closed timtebeek closed 3 months ago

timtebeek commented 5 months ago

As suggested on Slack.

My degree is not in education nor writing, i can only speak from my personal learning curve experience in the last three weeks. The docs are written very well, though it's feels like a lot to digest in the beginning. I kept thinking it may be good to have a beginner's FAQ, with simple straight Q & A, like in this case: „How do i remove an element from the LST“. Simple questions, short answers (where possible), with a link "Read more in {topic} here".

We have a hint as to removing elements on the best practices page image

But removing an element is so common that it might make sense to call that out explicitly in the FAQ, and from there link to where folks can read more. Perhaps also covering some of the nuance as explained here.

I meant if it's safe to remove in that particular spot, which can be surprising at times see for instance this very simple recipe we run that as part of our recipe best practices applied to every PR that quite bluntly removed any print statements, but at times results in odd auotmated code suggestions, as seen here in this case I see no need to fix that particular recipe just yet: it mostly works ok, and is a good trigger to start a discussion on PRs, but in other cases you might want to inspect what else is on the stack