Docs update - #31

Closed

a-magdy wants to merge 21 commits into

Praqma:mainfrom

a-magdy:docs-update

Commits on Jul 28, 2025

Add a 1 line description at the top of README.md
a-magdy
committed
dfc62c4
Add a 1 line description at the top of README.md
a-magdy
committed
2f58246
Update README.md to enhance clarity on benefits and rationale for using git-artifact
a-magdy
committed
c1aece2
Update the 1 line description at the top of the git-artifact
a-magdy
committed
ccbab0b
minor linting in git-artifact and _tests.sh
a-magdy
committed
a13c0b3
Refactor the first 2 sections in README.md to answer the 2 questions a new onlooker would ask
a-magdy
committed
9da1e40
Remove a second from README.md as it is now included in the Benefits section.
a-magdy
committed
8c54b51
Update the structure of README.md to get into how to use it faster
a-magdy
committed
916d4ae
Use copilot to proof read the README.md file
a-magdy
committed
a065190
minor linting update in git-artifact
a-magdy
committed
037e478
Replace the Super simple block with Quick Start (TL;DR)
a-magdy
committed
0f0b2be
Shorten the Quick Start
a-magdy
committed
a2f96c2
Move Notes section to above Advanced
a-magdy
committed
b52a060
Fix the git artifact init command and cd into the folder afterwards
a-magdy
committed
4101643

Commits on Jul 29, 2025

Update the install git-artifact section in the README
a-magdy
committed
5073a91
Update Quick Start (TL;DR) section to be a code block that can be copy pasted
a-magdy
committed
1710f38
Revert changes to the set_opts_spec
a-magdy
committed
ed03a6b
Fix mermaid code block formatting in README
a-magdy
committed
e592284
Move Key benefits to above quick start
a-magdy
committed
917c9ff
Use git clone in the README.md
a-magdy
committed
0e9763a

Commits on Jul 31, 2025

Help should be called only using (-h) for now (--help) will be supported later when we install man pages
a-magdy
committed
230d478