KylerOlsen/YREA-SLS
KylerOlsen
/
YREA-SLS
1
0
Fork 0
Code Releases 3 Wiki Activity

Cleaning up

This commit is contained in:
Kyler Olsen 2025-10-26 18:06:56 -06:00
parent 68cdf32e85
commit 19b19efa47
1 changed files with 78 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
reorganization plan.md
View File

@ -497,69 +497,69 @@ All primitive types implement Stackable.
- Related operators
**All Operators** (alphabetical):
- != (not equal)
- % (modulo)
- & (this is bitand)
- * (multiply)
- + (add)
- - (subtract)
- / (divide)
- < (less than)
- <= (less or equal)
- == (equal)
- > (greater than)
- >= (greater or equal)
- ^ (exponentiate)
- | (this is bitor)
- and (logical and)
- at (array access)
- bitand (bitwise and)
- bitnot (bitwise not)
- bitor (bitwise or)
- bitxor (bitwise xor)
- break (exit loop)
- concat (concatenate)
- continue (skip iteration)
- depth (stack depth)
- drop (remove top)
- dup (duplicate top)
- each (iterate)
- enum (define enum)
- eval (execute code)
- filter (filter array)
- fn (define function)
- for (for loop)
- get (field access)
- if (conditional)
- impl (implement trait)
- inher (trait inheritance)
- lambda (create lambda)
- length (container length)
- ln (natural log)
- log (log base 10)
- logb (log with base)
- map (transform array)
- match (pattern match)
- not (logical not)
- or (logical or)
- over (copy second)
- pick (copy nth)
- reduce (fold array)
- reverse (reverse array)
- roll (rotate n items)
- rot (rotate three)
- set (field assignment)
- shl (shift left)
- shr (shift right)
- slice (extract slice)
- struct (define struct)
- substr (substring)
- swap (swap two)
- trait (define trait)
- transpose (transpose array)
- union (define union)
- while (while loop)
- window (sliding window)
- `!=` (not equal)
- `%` (modulo)
- `&` (this is bitand)
- `*` (multiply)
- `+` (add)
- `-` (subtract)
- `/` (divide)
- `<` (less than)
- `<=` (less or equal)
- `==` (equal)
- `>` (greater than)
- `>=` (greater or equal)
- `^` (exponentiate)
- `|` (this is bitor)
- `and` (logical and)
- `at` (array access)
- `bitand` (bitwise and)
- `bitnot` (bitwise not)
- `bitor` (bitwise or)
- `bitxor` (bitwise xor)
- `break` (exit loop)
- `concat` (concatenate)
- `continue` (skip iteration)
- `depth` (stack depth)
- `drop` (remove top)
- `dup` (duplicate top)
- `each` (iterate)
- `enum` (define enum)
- `eval` (execute code)
- `filter` (filter array)
- `fn` (define function)
- `for` (for loop)
- `get` (field access)
- `if` (conditional)
- `impl` (implement trait)
- `inher` (trait inheritance)
- `lambda` (create lambda)
- `length` (container length)
- `ln` (natural log)
- `log` (log base 10)
- `logb` (log with base)
- `map` (transform array)
- `match` (pattern match)
- `not` (logical not)
- `or` (logical or)
- `over` (copy second)
- `pick` (copy nth)
- `reduce` (fold array)
- `reverse` (reverse array)
- `roll` (rotate n items)
- `rot` (rotate three)
- `set` (field assignment)
- `shl` (shift left)
- `shr` (shift right)
- `slice` (extract slice)
- `struct` (define struct)
- `substr` (substring)
- `swap` (swap two)
- `trait` (define trait)
- `transpose` (transpose array)
- `union` (define union)
- `while` (while loop)
- `window` (sliding window)
**Format Example**:
```
@ -629,19 +629,19 @@ for their complete specifications.
---
### Appendix G: Examples & Tutorials
**Content Source**: Appendix D from v0.7 + human-verified code blocks scattered throughout
**Content Source**: Appendix D from v0.7 ~~+ human-verified code blocks scattered throughout~~
**Organization**:
- G.1 Tutorial: First Steps
- G.2 Tutorial: Working with Traits
- G.3 Tutorial: Generic Programming
- G.4 Complete Examples (from current Appendix D)
- G.5 Verified Code Examples (human-reviewed blocks from throughout v0.7)
- ~~G.5 Verified Code Examples (human-reviewed blocks from throughout v0.7)~~ These were removed between v0.7 and v0.7.2.
**Changes**:
- Move all "Example - Actual Language Definitions" and "Example - Using Actual Definitions" blocks here
- Organize by topic/difficulty
- Add tutorial-style explanations
- Keep human verification notes with blocks
- ~~Keep human verification notes with blocks~~
**New Tutorial Sections**:
@ -671,10 +671,11 @@ for their complete specifications.
- D.7 Array Processing → G.4.7
- D.8 Identifier Literals in Practice → G.4.8
**G.5 Verified Code Examples**:
- All human-verified code blocks from v0.7
- Organized by topic
- Include verification notes
~~**G.5 Verified Code Examples**:~~
- ~~All human-verified code blocks from v0.7~~
- ~~Organized by topic~~
- ~~Include verification notes~~
These were removed between v0.7 and v0.7.2.
---
@ -727,7 +728,7 @@ for their complete specifications.
| New | Appendix A | Standard Library Reference |
| New | Appendix C | Operator Reference |
| New | Appendix G.1-G.3 | Tutorials |
| New | Appendix G.5 | Verified Examples |
| ~~New~~ | ~~Appendix G.5~~ | ~~Verified Examples~~ These were removed between v0.7 and v0.7.2. |
---
@ -761,15 +762,17 @@ To maintain minimal duplication, use consistent cross-references:
### Code Block Annotations
Preserve all human verification notes:
~~Preserve all human verification notes:~~
```
> **For AI Reviewers @ 0.5:** The following block has been human verified...
```
These were removed between v0.7 and v0.7.2.
Remove "Example - Actual Language Definitions" labels - replace with clearer context:
- "Defining a trait:" (instead of "Example - Actual Language Definitions:")
- "Using the operator:" (instead of "Example - Using Actual Definitions:")
- "Complete implementation:" (for full examples)
Where these weren't fixed between v0.6 and v0.7. Be careful not to confuse examples (including examples using *language definitions*/*appendix reference segments*; and examples that use code that isn't actually part of any build-in or standard library code) and the actual language definitions that are in the appendix sections A, B, and C.
### Section Headers
@ -826,7 +829,7 @@ For the AI agent implementing v0.8:
- [ ] Add cross-references throughout
- [ ] Remove duplicate content (trait definitions from main sections)
- [ ] Update all internal section references
- [ ] Preserve all human-verified code blocks with notes
- [ ] ~~Preserve all human-verified code blocks with notes~~ These were removed between v0.7 and v0.7.2.
- [ ] Remove "Example - Actual Language Definitions" labels
- [ ] Add reading guide to Section 1
- [ ] Verify all cross-references are valid
@ -852,13 +855,13 @@ The reorganization is successful if:
## Notes for Implementation Agent
1. **Preserve all human-verified blocks** - These have "For AI Reviewers @ 0.5" notes
1. ~~**Preserve all human-verified blocks** - These have "For AI Reviewers @ 0.5" notes~~ These were removed between v0.7 and v0.7.2.
2. **Don't paraphrase trait definitions** - Copy them exactly to Appendix B
3. **Keep code examples** - Don't summarize, show actual code
4. **Maintain postfix consistency** - All examples should be valid postfix notation
5. **Cross-reference liberally** - Better to over-reference than under-reference
6. **Check operator list completeness** - Appendix C must have ALL operators
7. **Alphabetize carefully** - Appendices A, B, C are reference material
8. **Preserve TODO comments** - Keep the one remaining human TODO
8. ~~**Preserve TODO comments** - Keep the one remaining human TODO~~ This was removed between v0.7 and v0.7.2.
9. **Grammar simplification** - Don't remove grammar, just avoid duplication
10. **Tutorial quality** - Appendix G.1-G.3 should be beginner-friendly