Update 2024-10-25-adr-templates.md

[azarboon]

Added some explanation to make it easier for beginners.

Btw, I would say there need to be some button like "edit this page" to encourage people to contribute. As of now, one needs to search for relevant files in the repo then make changes. It's not intuitive.

[azarboon]

@koppor and @socadk can you please review this PR so then we can proceed with best practices? BTW, please create a new section on the left hand menu name "Best practices" (or whatever you deem appropriate), so we can add to that.

[koppor]

Even though the VS Code Plugin is outdated (supports MADR 2.x only), we can take the risk in linking.

[azarboon]

Even though the VS Code Plugin is outdated (supports MADR 2.x only), we can take the risk in linking.

Good point. I will mention this.

[azarboon]

Even though the VS Code Plugin is outdated (supports MADR 2.x only), we can take the risk in linking.

Good point. I will mention this.

Done.

[azarboon]

@koppor thanks for suggestion. Committed it.

May I ask, what's the purpose of having that bold part? I'm curious what's the rational behind it?

MADR is about architectural decisions that matter ([ˈmæɾɚ])

[azarboon]

@koppor thanks for suggestion. Committed it.

May I ask, what's the purpose of having that bold part? I'm curious what's the rational behind it?

MADR is about architectural decisions that matter ([ˈmæɾɚ])

I see that word repeated twice in the first sentence of the main page of MADR, too. It's existence has baffled me:

[koppor]

I see that word repeated twice in the first sentence of the main page of MADR, too. It's existence has baffled me:

We can remove it. And also remove the link to pronounciation - too distracting. Just keeping "decisions that matter". Or even remove the sub heading at all.

[azarboon]

I see that word repeated twice in the first sentence of the main page of MADR, too. It's existence has baffled me:

We can remove it. And also remove the link to pronounciation - too distracting. Just keeping "decisions that matter". Or even remove the sub heading at all.

Done. I think it's ready to be merged. @socadk

[koppor]

Btw, I would say there need to be some button like "edit this page" to encourage people to contribute. As of now, one needs to search for relevant files in the repo then make changes. It's not intuitive.

We would need a new framework for this. The current "clean links" are a hack of the theme.

I think, we need to switch ... again ... -> https://docusaurus.io/

[azarboon]

@koppor can you please merge this PR?

[azarboon]

@koppor can you please merge this PR; because, I'm planning to add more improvements in another PRs. I've found some great tips and I would like to share them with readers.