Skip to content

Commit

Permalink
Update project name in .log4brains.yml and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
WayneGoosen committed Apr 20, 2024
1 parent 0724f85 commit cb2fb06
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 40 deletions.
2 changes: 1 addition & 1 deletion .log4brains.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
project:
name: WayneGoosen.github.io ADRs
name: Wayne Goosen Decision Records
tz: Europe/Zurich
adrFolder: ./docs/adr
packages:
Expand Down
47 changes: 43 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,48 @@
# adr
# ADR - A decision records experiment

This repository uses log4brains to publish all ADRs within this repository.

https://github.com/thomvaill/log4brains
The experiment: Use ADRs to track all decisions made on any projects within my github profile. If any project gets big enough move all the relevant ADRs to its repository.

# Log4Brains commands
## Why?

log4brains new adr
1. Log of all decisions for history and recall purposes. Sometimes we forget WHY we did something a certain way.
2. Visibility... Decisions around software are just trade offs and depend on the situation & context. This will help understand certain decisions.
3. Practise crafting ADRs. Thought provoking process which will I hope help make better decisions.
4. Bring in a level of professionalism with side projects.

# Architecture Decision Records

ADRs are automatically published to our Log4brains architecture knowledge base:

🔗 **<http://INSERT-YOUR-LOG4BRAINS-URL>**

Please use this link to browse them.

## Development

If not already done, install Log4brains:

```bash
npm install -g log4brains
```

To preview the knowledge base locally, run:

```bash
log4brains preview
```

In preview mode, the Hot Reload feature is enabled: any change you make to a markdown file is applied live in the UI.

To create a new ADR interactively, run:

```bash
log4brains adr new
```

## More information

- [Log4brains documentation](https://github.com/thomvaill/log4brains/tree/master#readme)
- [What is an ADR and why should you use them](https://github.com/thomvaill/log4brains/tree/master#-what-is-an-adr-and-why-should-you-use-them)
- [ADR GitHub organization](https://adr.github.io/)
35 changes: 0 additions & 35 deletions docs/adr/README.md

This file was deleted.

0 comments on commit cb2fb06

Please sign in to comment.