dasdasd

Author: rodiazet

README.md

@@ -0,0 +1,157 @@
+# Ipsilon Documentation# Ipsilon Notes & GitHub Pages Site
+
+
+
+Welcome to the Ipsilon team's public documentation repository. This collection contains research notes, technical specifications, and performance analyses related to Ethereum Virtual Machine (EVM) improvements and the Ethereum Object Format (EOF).This repository contains a public documentation site with filtered notes and a simple static interface for browsing them by tags.
+
+
+
+## 📋 All Documentation## Structure
+
+
+
+### EVM Object Format (EOF)- `public/` – All public-facing content for GitHub Pages deployment
+
+  - `public/notes/` – Public markdown files (25 notes matching what's visible on notes.ethereum.org/@ipsilon)
+
+- [EOF "Option D" Summary](notes/EOF%20_Option%20D_%20Summary.md) - Summary of EOF Option D design decisions  - `public/index.html`, `public/assets/` – Static site for tag filtering, search, and viewing
+
+- [EOF - Solidity library compatibility (initial) report](notes/EOF%20-%20Solidity%20library%20compatibility%20(initial)%20report.md) - Analysis of EOF impact on Solidity libraries  - `public/notes_index.json` – Generated JSON index consumed by the site
+
+- [EOF Fusaka Options](notes/EOF%20Fusaka%20Options.md) - Decision tree for EOF/EVM changes in Fusaka- `private-notes/` – Private/internal notes (176 files, preserved but not published)
+
+- [EOF Prefix](notes/EOF%20Prefix.md) - Process of choosing EOF magic sequence- `generate_notes_index.py` – Script to (re)generate the JSON index
+
+- [EOF bootstrapping](notes/EOF%20bootstrapping.md) - Options for EOF bootstrapping with TXCREATE- `filter_public_notes.py` – Script used to separate public from private notes
+
+- [EOF: Ethereum's Gateway to RISC-V Execution](notes/EOF_%20Ethereum's%20Gateway%20to%20RISC-V%20Execution.md) - EOF as transition path to RISC-V
+
+- [Everything about the EVM Object Format (EOF)](notes/Everything%20about%20the%20EVM%20Object%20Format%20(EOF).md) - Comprehensive EOF explainer## Regenerating the Index
+
+- [Explainer of evmone Codecov report for EOF tests](notes/Explainer%20of%20%60evmone%60%20Codecov%20report%20for%20EOF%20tests.md) - Testing coverage analysis
+
+- [Measurable benefits of EOF](notes/Measurable%20benefits%20of%20EOF.md) - Performance benchmarks and benefits analysisRun locally from repository root:
+
+- [PEEPanEIP-3540_3670: EVM Object Format (EOF) v1](notes/PEEPanEIP-3540_3670_%20EVM%20Object%20Format%20(EOF)%20v1.md) - EIP presentation materials
+
+- [Potential scenarios of updating the new contract address schemes for EOF](notes/Potential%20scenarios%20of%20updating%20the%20new%20contract%20address%20schemes%20for%20EOF.md) - Address scheme considerations```bash
+
+python3 generate_notes_index.py
+
+### EVMMAX (EVM Modular Arithmetic Extension)```
+
+
+
+- [EVMMAX](notes/EVMMAX.md) - Core EVMMAX documentationCommit the updated `public/notes_index.json` so the site reflects changes.
+
+- [EVMMAX Breakout - Devcon SEA L1 R&D Workshop](notes/EVMMAX%20Breakout%20-%20Devcon%20SEA%20L1%20R&D%20Workshop.md) - Workshop notes and plans
+
+- [EVMMAX in evmone](notes/EVMMAX%20in%20evmone.md) - Implementation details in evmone## Tag Extraction Rules
+
+- [EVMMAX website](notes/EVMMAX%20website.md) - Website content and information
+
+The script looks in the first 30 lines of each file in `public/notes/` for:
+
+### EVM Performance & Optimization
+
+```
+
+- [EVM Performance Report — Geth & Go Compiler](notes/EVM%20Performance%20Report%20—%20Geth%20&%20Go%20Compiler.md) - Performance comparison across Go versions###### tags: `tag1` `tag2`
+
+- [EVM Performance Report — Geth vs evmone](notes/EVM%20Performance%20Report%20—%20Geth%20vs%20evmone.md) - Comparative performance analysistags: tag1, tag2, tag3
+
+- [Faster Ethash check against difficulty](notes/Faster%20Ethash%20check%20against%20difficulty.md) - Optimization techniquetags: tag1 tag2 tag3
+
+```
+
+### EIP Presentations & Analysis
+
+Backtick-quoted tags are preferred; otherwise it splits on commas or spaces.
+
+- [PEEPanEIP-3855: PUSH0 Instruction](notes/PEEPanEIP-3855_%20PUSH0%20Instruction.md) - PUSH0 instruction presentation
+
+- [PEEPanEIP-3860: Limit and meter initcode](notes/PEEPanEIP-3860_%20Limit%20and%20meter%20initcode.md) - Initcode limitations presentation## Enabling GitHub Pages
+
+
+
+### Research & Technical Analysis1. Open repository Settings → Pages.
+
+2. Set Source to "Deploy from a branch" and select branch `main`, folder `public/`, then Save.
+
+- [IS_CONTRACT instruction](notes/IS_CONTRACT%20instruction.md) - New instruction proposal3. After deployment, visit the generated URL. The site will load `notes_index.json` and allow browsing.
+
+- [Osaka Testnets Plan](notes/Osaka%20Testnets%20Plan.md) - Testing strategy and roadmap
+
+- [Pairing: Linear function evaluation + point addition/doubling in Jacobian coordinates](notes/Pairing_%20Linear%20function%20evaluation%20+%20point%20addition_doubling%20in%20Jacobian%20coordinates.md) - Cryptographic implementation details## Usage
+
+- [Why EVM has JUMPDEST](notes/Why%20EVM%20has%20JUMPDEST.md) - Historical and technical explanation
+
+1. Use the tag pills to filter (AND logic across selected tags).
+
+### About Ipsilon2. Use the search box to fuzzy match title and tags.
+
+3. Click a note to load and render its markdown (client-side rendering via `marked` library CDN).
+
+- [Ipsilon website](notes/Ipsilon%20website.md) - Team information and background4. The URL hash tracks the current note; shareable deep link.
+
+
+
+## 🔗 Interactive Documentation Site## Updating / Adding Notes
+
+
+
+Visit our [interactive documentation site](https://ipsilon.github.io/documentation/) for a better browsing experience with:1. Place new `.md` files in `public/notes/` (or edit existing ones).
+
+- 🏷️ Tag-based filtering2. Add a tag line near the top for discoverability.
+
+- 🔍 Full-text search3. Re-run the index generation script.
+
+- 📱 Mobile-friendly interface4. Commit & push.
+
+- 🔗 Direct links to GitHub for editing
+
+## Content Filtering
+
+## 🏗️ Repository Structure
+
+The repository now contains only 25 public notes (matching what's visible on notes.ethereum.org/@ipsilon for unlogged users). All private/internal documentation (176 files) is preserved in `private-notes/` but not published to GitHub Pages.
+
+```
+
+├── notes/              # Public documentation (25 files)## Future Improvements (Optional)
+
+├── private-notes/      # Internal notes (preserved but not published)
+
+├── generate_notes_index.py    # Script to generate site index- Add front matter normalization (convert tags line to YAML front matter).
+
+├── filter_public_notes.py     # Script to filter public content- Add full-text search (e.g. Lunr.js) for content body.
+
+└── README.md          # This file- Multi-tag OR logic toggle.
+
+```- Tag cloud weighting by frequency.
+
+- Automatic GitHub Action to regenerate index on push.
+
+## 📝 Contributing
+
+## License
+
+To add or update documentation:
+
+Site assets are provided under MIT; content retains its original licensing.
+
+1. Place markdown files in the `notes/` directory
+2. Add appropriate tags in the first 30 lines:
+   ```markdown
+   ###### tags: `EOF` `research`
+   ```
+3. Run `python3 generate_notes_index.py` to update the site index
+4. Commit and push changes
+
+## 📄 License
+
+This documentation is provided under the MIT License. Individual documents may retain their original licensing terms.
+
+---
+
+*This repository contains public documentation from the Ipsilon team, an Ethereum Foundation-funded research group focused on EVM improvements and the Ethereum Object Format (EOF).*