Skip to content

Commit 8790ab2

Browse files
authored
chore(docs): polish landing page wording & examples (#90)
1 parent 6cf62b1 commit 8790ab2

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

docs/src/app/page.tsx

+8-10
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ const HeroSection = () => {
4444
<div className="relative z-10 text-center">
4545
<h1 className="text-4xl sm:text-5xl md:text-6xl font-bold font-mono mb-4">bulloak</h1>
4646
<p className="text-lg sm:text-xl mb-8">
47-
A test generator based on the Branching Tree Technique
47+
A smart contract test generator based on the Branching Tree Technique
4848
</p>
4949
<Link href="https://github.com/alexfertel/bulloak" target="_blank" className="inline-flex items-center justify-center bg-slate-800 text-slate-100 px-4 sm:px-6 py-2 rounded-md hover:bg-slate-700 text-sm sm:text-base">
5050
<GitHubIcon className="w-4 h-4 mr-2" />
@@ -77,7 +77,6 @@ const BTTExplanationSection = () => {
7777
<h3 className="text-lg sm:text-xl font-bold mb-4">Example BTT Structure</h3>
7878
<pre className="text-xs sm:text-sm font-mono overflow-x-auto">
7979
{`HashPairTest
80-
├── It should never revert.
8180
├── When first arg is smaller than second arg
8281
│ └── It should match the result of keccak256(a,b).
8382
└── When first arg is bigger than second arg
@@ -112,26 +111,26 @@ const BulloakFeaturesSection = () => {
112111
<p className="text-base sm:text-lg mb-6">
113112
bulloak is a powerful tool that brings the Branching Tree Technique to life for developers. It automates the process of creating comprehensive test suites based on BTT specifications.
114113
{" "}<Link href="https://github.com/alexfertel/bulloak" target="_blank" className="inline-flex text-base sm:text-lg font-bold underline hover:text-slate-600">
115-
Read the full README on GitHub.
114+
Check out the full README on GitHub.
116115
</Link>
117116
</p>
118117
<pre className="text-sm sm:text-base font-mono overflow-x-auto mb-6 px-4 bg-slate-200 rounded">
119118
<code>{`
120119
Bulloak
121120
├── Scaffold Command
122-
│ ├─── Automatically generates test files from .tree specifications
121+
│ ├─── Generates test files from .tree specifications
123122
│ │ ├── Creates modifiers for conditions
124123
│ │ └── Generates test functions for actions
125124
│ ├─── Reports syntax errors in your specification
126125
│ └─── Provides a full AST for easy extension
127126
├── Check Command
128-
│ ├── Ensures code matches its specification
127+
│ ├── Ensures implementation matches its specification
129128
│ ├── Reports missing tests
130129
│ └── Identifies structural mismatches
131130
├── Multiple Tree Support
132131
│ └── Define multiple test trees in a single file
133132
├── Flexible Syntax
134-
│ ├── Supports 'when' and 'given' for conditions
133+
│ ├── Supports 'when' and 'given' for conditions and states, respectively
135134
│ └── Case-insensitive keywords
136135
└── Automatic Fixes
137136
├── Adds missing functions
@@ -145,7 +144,6 @@ Bulloak
145144
<pre className="border border-slate-300 text-slate-900 px-4 overflow-x-auto text-xs sm:text-sm">
146145
<code>{`
147146
HashPairTest
148-
├── It should never revert.
149147
├── When first arg is smaller than second arg
150148
│ └── It should match the result of
151149
│ keccak256(abi.encodePacked(a,b)).
@@ -258,9 +256,9 @@ const Footer = () => {
258256
<div className="col-span-1">
259257
<h3 className="text-lg sm:text-xl font-bold mb-4">Resources/</h3>
260258
<ul>
261-
<li><span className="mr-2">├──</span><Link href="https://www.youtube.com/watch?v=V6KBy8QQnCo" target="_blank" className="hover:underline hover:text-slate-600">Presentation by Paul R. Berg at EthCC[6]</Link></li>
262-
<li><span className="mr-2">├──</span><Link href="https://www.youtube.com/watch?v=V6KBy8QQnCo" target="_blank" className="hover:underline hover:text-slate-600">Presentation by Paul R. Berg at Devconnect</Link></li>
263259
<li><span className="mr-2">├──</span><Link href="https://github.com/PaulRBerg/btt-examples" target="_blank" className="hover:underline hover:text-slate-600">BTT examples</Link></li>
260+
<li><span className="mr-2">├──</span><Link href="https://youtu.be/V6KBy8QQnCo" target="_blank" className="hover:underline hover:text-slate-600">Paul Berg&apos;s presentation at EthCC[6]</Link></li>
261+
<li><span className="mr-2">├──</span><Link href="https://youtu.be/0-EmbNVgFA4" target="_blank" className="hover:underline hover:text-slate-600">Paul Berg&apos;s presentation at Solidity Summit</Link></li>
264262
<li><span className="mr-2">├──</span><Link href="https://marketplace.visualstudio.com/items?itemName=aprilandjan.ascii-tree-generator" target="_blank" className="hover:underline hover:text-slate-600">Ascii Tree Generator for VSCode</Link></li>
265263
<li><span className="mr-2">└──</span><Link href="https://marketplace.visualstudio.com/items?itemName=PraneshASP.vscode-solidity-inspector" className="hover:underline hover:text-slate-600">Syntax highlighting for tree files for VSCode</Link></li>
266264
</ul>
@@ -281,7 +279,7 @@ const Footer = () => {
281279
</div>
282280
</div>
283281
<div className="mt-10 sm:mt-12 text-xs sm:text-sm flex items-center justify-end">
284-
Created by <Link href="https://alexfertel.me" target="_blank" className="ml-1 text-blue-600 hover:underline font-mono">alexfertel</Link>.
282+
Created by <Link href="https://alexfertel.me" target="_blank" className="ml-1 text-blue-600 hover:underline font-mono">alexfertel</Link>
285283
</div>
286284
</div>
287285
</footer>

0 commit comments

Comments
 (0)