Skip to content

Commit 3aadd80

Browse files
savagelysubtlesavagelysubtle
committed
Enhance documentation with dark green theme and expanded content
1 parent 20cedd0 commit 3aadd80

File tree

6 files changed

+742
-69
lines changed

6 files changed

+742
-69
lines changed

‎docs/Guides/index.md

Lines changed: 69 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,88 @@
11
---
22
layout: default
3-
title: Guides
3+
title: Getting Started
44
nav_order: 2
55
has_children: true
66
permalink: /guides/
77
---
88

9-
# BIG BRAIN Memory Bank 2.0 Guides
9+
# Getting Started with BIG BRAIN Memory Bank 2.0
1010

11-
This section contains comprehensive guides for working with the BIG BRAIN Memory
12-
Bank 2.0 system. These guides provide step-by-step instructions for different
13-
aspects of the system, from installation to advanced usage.
11+
Welcome to the Getting Started section of the BIG BRAIN Memory Bank 2.0
12+
documentation. This section provides all the essential guides to help you begin
13+
using the Memory Bank system effectively.
14+
15+
{: .fs-6 .fw-300 }
16+
17+
## What is BIG BRAIN Memory Bank?
18+
19+
BIG BRAIN Memory Bank is a sophisticated knowledge persistence system designed
20+
specifically for environments where memory completely resets between sessions.
21+
It provides a structured approach to documentation, allowing for perfect recall
22+
of project information, system architecture, and operational context even after
23+
a complete memory reset.
24+
25+
## Key Capabilities
26+
27+
- **Perfect Recall** - Access complete project knowledge after memory resets
28+
- **Structured Documentation** - Organized information architecture for
29+
efficient retrieval
30+
- **Consistent Operations** - Maintain operational continuity across sessions
31+
- **Systematic Verification** - Built-in mechanisms to validate system integrity
32+
- **Standardized Workflows** - Clear processes for common tasks
1433

1534
## Available Guides
1635

17-
- [Installation Guide](Installation.md) - How to install and configure the
18-
system
19-
- [Startup Guide](Startup.md) - How to initialize and start using the system
20-
- [Commands Guide](Commands.md) - Reference for all system commands
21-
- [Initialization Scripts](InitializationScripts.md) - Guide to system
22-
initialization scripts
36+
<div class="guides-grid">
37+
<div class="guide-card">
38+
<h3><a href="{{ site.baseurl }}/guides/installation/">Installation Guide</a></h3>
39+
<p>Step-by-step instructions for setting up BIG BRAIN Memory Bank 2.0</p>
40+
<a href="{{ site.baseurl }}/guides/installation/" class="btn">Read Guide</a>
41+
</div>
2342

24-
## Guide Selection
43+
<div class="guide-card">
44+
<h3><a href="{{ site.baseurl }}/guides/startup/">Startup Guide</a></h3>
45+
<p>Learn how to initialize and start using the Memory Bank system</p>
46+
<a href="{{ site.baseurl }}/guides/startup/" class="btn">Read Guide</a>
47+
</div>
2548

26-
Choose the appropriate guide based on your current needs:
49+
<div class="guide-card">
50+
<h3><a href="{{ site.baseurl }}/guides/commands/">Commands Guide</a></h3>
51+
<p>Reference for all system commands and how to use them effectively</p>
52+
<a href="{{ site.baseurl }}/guides/commands/" class="btn">Read Guide</a>
53+
</div>
2754

28-
1. **New to BIG BRAIN?** Start with the [Installation Guide](Installation.md)
29-
followed by the [Startup Guide](Startup.md)
30-
2. **Already installed?** Use the [Commands Guide](Commands.md) for quick
31-
reference
32-
3. **Need to initialize or reset?** Refer to the
33-
[Initialization Scripts](InitializationScripts.md) guide
55+
<div class="guide-card">
56+
<h3><a href="{{ site.baseurl }}/guides/initialization-scripts/">Initialization Scripts</a></h3>
57+
<p>Understanding the scripts that help bootstrap the system</p>
58+
<a href="{{ site.baseurl }}/guides/initialization-scripts/" class="btn">Read Guide</a>
59+
</div>
60+
</div>
3461

35-
## Guide Usage Tips
62+
## First Steps
3663

37-
- Each guide is designed to be self-contained but may reference other guides for
38-
related information
39-
- Code examples can be copied directly from the guides
40-
- Command references include all required parameters and options
41-
- Screenshots are provided for complex operations
64+
If you're new to BIG BRAIN Memory Bank, we recommend following these steps:
4265

43-
## Getting Help
66+
1. **Installation** - Follow the [Installation
67+
Guide]({{ site.baseurl }}/guides/installation/) to set up the system
68+
2. **System Initialization** - Use the [Startup
69+
Guide]({{ site.baseurl }}/guides/startup/) to initialize the system
70+
3. **Learn Commands** - Familiarize yourself with the [Commands
71+
Guide]({{ site.baseurl }}/guides/commands/)
72+
4. **Explore Architecture** - Understand the [system
73+
architecture]({{ site.baseurl }}/architecture/overview/)
4474

45-
If you encounter issues with any of the guides:
75+
## Need Help?
76+
77+
If you encounter any issues while getting started:
78+
79+
- Review the [Troubleshooting
80+
Guide]({{ site.baseurl }}/reference/troubleshooting/)
81+
- Execute the `MEMORY HEALTH CHECK` command to diagnose system issues
82+
- Check for [known issues]({{ site.baseurl }}/reference/known-issues/) that
83+
might affect your setup
84+
85+
---
4686

47-
1. Check the specific guide's troubleshooting section
48-
2. Refer to the [Known Issues](../Reference/KnownIssues.md) documentation
49-
3. Run the `MEMORY HEALTH CHECK` command for system diagnostics
87+
Ready to dive in? Start with the [Installation
88+
Guide]({{ site.baseurl }}/guides/installation/) →

‎docs/Memory-Bank/bedtime-protocol.md

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
---
2+
layout: default
3+
title: Bedtime Protocol
4+
parent: Memory Bank
5+
nav_order: 4
6+
permalink: /memory-bank/bedtime-protocol/
7+
---
8+
9+
# Bedtime Protocol
10+
11+
The Bedtime Protocol is a critical system process designed to preserve the
12+
operational state of BIG BRAIN before a memory reset occurs. This protocol
13+
ensures that all essential information is captured, verified, and properly
14+
structured to enable perfect recall in the next session.
15+
16+
{: .fs-6 .fw-300 }
17+
18+
## Purpose and Importance
19+
20+
The Bedtime Protocol serves as the bridge between operational sessions, ensuring
21+
continuity and consistency despite the complete memory reset that occurs between
22+
sessions. It transforms volatile, in-memory knowledge into persistent,
23+
structured documentation.
24+
25+
Without proper execution of the Bedtime Protocol, critical context would be
26+
lost, leading to:
27+
28+
- Reduced operational efficiency
29+
- Inconsistent decision-making
30+
- Loss of project momentum
31+
- Degraded understanding of project state
32+
33+
## Protocol Phases
34+
35+
The Bedtime Protocol consists of five distinct phases, each with specific goals
36+
and procedures:
37+
38+
<div class="protocol-phases">
39+
<div class="phase">
40+
<div class="phase-number">1</div>
41+
<div class="phase-content">
42+
<h3>Capture Phase</h3>
43+
<p>Document all volatile state information that exists only in active memory.</p>
44+
<ul>
45+
<li>Current task context and progress</li>
46+
<li>Recent decisions and their rationale</li>
47+
<li>Unsaved changes or work-in-progress</li>
48+
<li>Mental models and understanding developed during the session</li>
49+
</ul>
50+
</div>
51+
</div>
52+
53+
<div class="phase">
54+
<div class="phase-number">2</div>
55+
<div class="phase-content">
56+
<h3>Update Phase</h3>
57+
<p>Systematically update all core Memory Bank files to reflect the current state.</p>
58+
<ul>
59+
<li>Update activeContext.md with current focus and next steps</li>
60+
<li>Revise progress.md to reflect completed tasks and new issues</li>
61+
<li>Update any other core files as needed</li>
62+
<li>Ensure documentation of any new patterns discovered</li>
63+
</ul>
64+
</div>
65+
</div>
66+
67+
<div class="phase">
68+
<div class="phase-number">3</div>
69+
<div class="phase-content">
70+
<h3>Verification Phase</h3>
71+
<p>Verify the integrity and completeness of the Memory Bank.</p>
72+
<ul>
73+
<li>Check for missing information or documentation gaps</li>
74+
<li>Ensure core files are up-to-date and accurately reflect system state</li>
75+
<li>Validate that next steps are clearly documented for the next session</li>
76+
<li>Review for consistency and clarity from a "cold start" perspective</li>
77+
</ul>
78+
</div>
79+
</div>
80+
81+
<div class="phase">
82+
<div class="phase-number">4</div>
83+
<div class="phase-content">
84+
<h3>Preparation Phase</h3>
85+
<p>Set up the environment for successful initialization in the next session.</p>
86+
<ul>
87+
<li>Ensure all documentation is committed and pushed to the repository</li>
88+
<li>Create clear entry points for the next session</li>
89+
<li>Document any environment-specific details needed for restart</li>
90+
<li>Prepare initialization scripts if needed</li>
91+
</ul>
92+
</div>
93+
</div>
94+
95+
<div class="phase">
96+
<div class="phase-number">5</div>
97+
<div class="phase-content">
98+
<h3>Shutdown Phase</h3>
99+
<p>Conclude the current session in a controlled manner.</p>
100+
<ul>
101+
<li>Final verification of Memory Bank state</li>
102+
<li>Confirmation that all changes are saved and persisted</li>
103+
<li>Ready signal for memory reset</li>
104+
<li>Graceful conclusion of the session</li>
105+
</ul>
106+
</div>
107+
</div>
108+
</div>
109+
110+
## Execution Commands
111+
112+
The Bedtime Protocol is typically initiated with the command:
113+
114+
```shell
115+
BEDTIME PROTOCOL INITIATE
116+
```
117+
118+
This triggers the guided workflow through all phases of the protocol.
119+
Alternatively, individual phases can be executed with:
120+
121+
```shell
122+
BEDTIME PROTOCOL EXECUTE [PHASE_NAME]
123+
```
124+
125+
Where `[PHASE_NAME]` is one of: `CAPTURE`, `UPDATE`, `VERIFY`, `PREPARE`, or
126+
`SHUTDOWN`.
127+
128+
## Best Practices
129+
130+
For optimal execution of the Bedtime Protocol:
131+
132+
1. **Allow Sufficient Time**: The protocol requires careful attention and should
133+
not be rushed.
134+
135+
2. **Complete Current Tasks**: When possible, complete in-progress tasks before
136+
initiating the protocol.
137+
138+
3. **Use Checklists**: Follow phase-specific checklists to ensure completeness.
139+
140+
4. **Think Forward**: Consider what information would be most valuable when
141+
starting fresh.
142+
143+
5. **Verify Independently**: Review documentation as if you have no prior
144+
knowledge of the project.
145+
146+
## Troubleshooting
147+
148+
If issues occur during the Bedtime Protocol:
149+
150+
- **Incomplete Information**: Return to the Capture phase and collect missing
151+
details
152+
- **Inconsistencies**: Resolve contradictions between documentation files
153+
- **Verification Failures**: Address specific issues flagged during verification
154+
- **Time Constraints**: Prioritize updating core files if time is limited
155+
156+
## Example Workflow
157+
158+
A typical Bedtime Protocol execution might look like:
159+
160+
1. Recognize the need to end the current session
161+
2. Execute `BEDTIME PROTOCOL INITIATE`
162+
3. Follow the guided prompts for each phase
163+
4. Document current progress in activeContext.md
164+
5. Update progress.md with completed items and known issues
165+
6. Verify all core files are current and consistent
166+
7. Commit and push all changes to the repository
167+
8. Confirm ready for memory reset
168+
9. End session
169+
170+
---
171+
172+
**Remember**: The thoroughness of your Bedtime Protocol directly impacts the
173+
effectiveness of the next session. Invest the time to do it properly!

0 commit comments

Comments
 (0)