Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
e221f5e
add initial draft of integraion docs
Cordtus Oct 13, 2025
15c7b8e
fix syntax break
Cordtus Oct 13, 2025
4fccd76
fix broken links, add proper refs
Cordtus Oct 13, 2025
6e8bfe6
improve wording
Cordtus Oct 13, 2025
1423620
rearrange pages, remove obsolete pages, improve content
Cordtus Oct 13, 2025
dea62b8
further corrections
Cordtus Oct 13, 2025
fa4798e
fix nav
Cordtus Oct 13, 2025
9c0d6c0
fix errors
Cordtus Oct 13, 2025
72b60ef
add comprehensive module docs, remove 500 syntax breaking gremlins
Cordtus Oct 13, 2025
e229611
fix broken pages, sidebar names
Cordtus Oct 13, 2025
3b7f2bb
fix more sidebar goofiness and title hell
Cordtus Oct 13, 2025
7e55655
clean up nav
Cordtus Oct 13, 2025
f78edb5
fix paths
Cordtus Oct 13, 2025
962b7a0
remove garbage emojis
Cordtus Oct 13, 2025
40318dd
clean up overview pages junk
Cordtus Oct 13, 2025
96ee012
fix and improve precompiles info and correct addrs
Cordtus Oct 13, 2025
b11a25c
Capitalize Migrations
Cordtus Oct 13, 2025
9fd1506
consolidate modules docs and update all refs
Cordtus Oct 13, 2025
410a136
fix everything
Cordtus Oct 13, 2025
fb53ab3
Add changes and fixes
vladjdk Oct 14, 2025
8f02aa7
Merge pull request #99 from vladjdk/vlad/0.5-cleanup
Cordtus Oct 14, 2025
0668013
remove duplicated titles, add some context on token config
Cordtus Oct 14, 2025
af9fdb6
add to faq
Cordtus Oct 14, 2025
b2c0310
move additional/optional integration docs into new category
Cordtus Oct 14, 2025
acbb4f0
update refs to moved page
Cordtus Oct 14, 2025
7b212f8
fix path
Cordtus Oct 14, 2025
5ce05b5
improve wording
Cordtus Oct 14, 2025
3bb4542
improve wording
Cordtus Oct 14, 2025
62d9d8c
fix broken links
Cordtus Oct 14, 2025
c5a4de7
fix more broken links
Cordtus Oct 14, 2025
236a8cd
fix more broken links
Cordtus Oct 14, 2025
9c215ab
add deep context on module params
Cordtus Oct 14, 2025
f504128
fix links in cards
Cordtus Oct 14, 2025
9d628cd
Fix chain ID documentation and clarify EIP integration
Cordtus Oct 14, 2025
1ef062d
Remove unnecessary warning callouts about chain ID separation
Cordtus Oct 14, 2025
5486bc7
Remove repetitive statements about chain ID independence
Cordtus Oct 14, 2025
4011a8e
Remove precompile count from documentation
Cordtus Oct 14, 2025
8acb57f
Remove baseless warning callouts
Cordtus Oct 14, 2025
47b9baf
hide setup checklist
Cordtus Oct 14, 2025
0b35826
Merge pull request #100 from cosmos/docs/fix-chain-id-and-eip-documen…
Cordtus Oct 14, 2025
e559521
improve guided setup checklist
Cordtus Oct 14, 2025
f91f87e
dump all progress to preview
Cordtus Oct 15, 2025
3a9cb99
add whole sdk docs unedited
Cordtus Oct 15, 2025
351203f
restore full sdk docs
Cordtus Oct 15, 2025
4e29965
..
Cordtus Oct 15, 2025
a02037f
unignore ./build
Cordtus Oct 15, 2025
b668cef
add build dirs
Cordtus Oct 15, 2025
03185a2
finalize build chain docs
Cordtus Oct 15, 2025
024566b
remove syntax breaking --- from all files
Cordtus Oct 15, 2025
04dbfff
make all codeblocks expandable, and various cleanup
Cordtus Oct 15, 2025
1f1c138
first pass major cleanup to build docs
Cordtus Oct 15, 2025
e53e367
fix some slop
Cordtus Oct 16, 2025
bb7b69d
misc. cleanup and reorg of older content
Cordtus Oct 16, 2025
c11aae3
Merge pull request #101 from cosmos/cordt/v0.5.0-final
Cordtus Oct 16, 2025
d2bfbe6
Merge remote-tracking branch 'origin/v0.5.0-integration' into neil/ad…
Cordtus Oct 16, 2025
ab533d2
prep for Neil
Cordtus Oct 16, 2025
3a70a30
nc test script
Totalspud Oct 16, 2025
71f4647
test fix adr links in next from version v0v447
Totalspud Oct 16, 2025
bc5abec
nc broken links test fixes
Totalspud Oct 17, 2025
021ca91
link fixes
Totalspud Oct 17, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 0 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,6 @@ schema.json
docs/logs/
logs/
dist/
build/

# --- allow SDK docs build/ dirs (override rule above) ---
!docs/sdk/v0.53/build/
!docs/sdk/v0.53/build/**
!docs/sdk/v0.50/build/
!docs/sdk/v0.50/build/**
!docs/sdk/v0.47/build/
!docs/sdk/v0.47/build/**
# --------------------------------------------------------

.yarn/
# Keep most scripts ignored, but include versioning tools
Expand Down
10 changes: 10 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Mintlify MDX files - Prettier breaks MDX component formatting
**/*.mdx

# Node modules
node_modules/

# Build output
.next/
dist/
build/
352 changes: 352 additions & 0 deletions WORKFLOW-GUIDE-fix-next-adr-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,352 @@
# Professional Git Workflow: Fixing SDK Links in `docs/sdk/next`

**Task:** Fix broken Docusaurus syntax and relative links in `./docs/sdk/next/build/architecture` ADR files.

---

## 📋 Quick Reference Checklist

- [ ] Step 1: Sync local branch
- [ ] Step 2: Create backup/feature branch
- [ ] Step 3: Assess current state
- [ ] Step 4: Examine sample files
- [ ] Step 5: Plan approach (communicate with team)
- [ ] Step 6: Execute the fix
- [ ] Step 7: Modify/check link-fixing script
- [ ] Step 8: Run link fixes
- [ ] Step 9: Test changes locally
- [ ] Step 10: Review your work
- [ ] Step 11: Commit with clear message
- [ ] Step 12: Push and create PR
- [ ] Step 13: Respond to review feedback

---

## Step 1: Sync Your Local Branch ✅

```bash
# Make sure you're on the correct branch
git checkout neil/adr-fixes

# Fetch all remote changes
git fetch origin

# Pull changes from your base branch
git pull origin neil/adr-fixes
```

**Why:** Always start with a clean, up-to-date workspace to avoid merge conflicts later.

---

## Step 2: Create a Safety Checkpoint 🔖

```bash
# Create a backup branch (just in case)
git branch neil/adr-fixes-backup

# Or create a new feature branch for this specific work
git checkout -b neil/fix-next-adr-links
```

**Why:** Professional developers always have an escape hatch. If something goes wrong, you can easily return to a known good state.

---

## Step 3: Assess the Current State 🔍

```bash
# Look at the structure
ls -la docs/sdk/next/build/architecture/

# Check git status to see what's already changed
git status

# Compare next with a corrected version
ls docs/sdk/v0.47/build/architecture/ | head -20
ls docs/sdk/next/build/architecture/ | head -20
```

**Why:** Before making changes, understand what you're working with. Compare the broken files with the fixed versions.

---

## Step 4: Examine Sample Files 📄

```bash
# Look at a broken file in next
cat docs/sdk/next/build/architecture/adr-033-protobuf-inter-module-comm.mdx | head -50

# Compare with the fixed version from v0.47
cat docs/sdk/v0.47/build/architecture/adr-033-protobuf-inter-module-comm.mdx | head -50

# Look for differences
diff docs/sdk/next/build/architecture/adr-033-protobuf-inter-module-comm.mdx \
docs/sdk/v0.47/build/architecture/adr-033-protobuf-inter-module-comm.mdx
```

**Why:** Understand what "broken" means - what syntax issues exist? This informs your fix strategy.

---

## Step 5: Plan Your Approach 📝

**Option A: Copy Fixed Files (Quick but Creates Version Links)**
- Copy all ADR files from `v0.47` to `next`
- Links will point to v0.47 paths
- Fast, but navigation might confuse users

**Option B: Fix in Place (More Work but Cleaner)**
- Fix syntax issues in `next` files
- Update script to also fix `next` directory
- Run link-fixing script specifically on `next`
- More work, but links stay within `next` version

**Professional Decision:** Discuss with your colleague first! Send a message like:

```
"Hey! Looking at the next/architecture ADRs. I see two approaches:

1. Copy corrected files from v0.47 → quick but links go to v0.47
2. Fix syntax + run link script on next → more work but cleaner

Since you mentioned it's okay if links navigate to other versions temporarily,
I'm thinking Option 1 for now. We can do a proper fix later. Thoughts?"
```

**Why:** Professional devs communicate before making architectural decisions.

---

## Step 6: Execute the Fix (Assuming Option A Chosen) 🛠️

```bash
# Create a test copy first
mkdir -p /tmp/test-fix
cp -r docs/sdk/next/build/architecture /tmp/test-fix/

# Copy corrected files from v0.47 to next
cp docs/sdk/v0.47/build/architecture/*.mdx docs/sdk/next/build/architecture/

# Check what changed
git status
git diff docs/sdk/next/build/architecture/ | head -100
```

**Why:** Test first, then apply. Check the diff to ensure nothing unexpected happened.

---

## Step 7: Modify the Link-Fixing Script 🔧

The script currently scans all `docs/sdk/**/*.mdx` files, so it should already include `next`.

**Verify the script will process next:**

```bash
# Run in dry-run mode to see if it finds next files
node scripts/fix-sdk-relative-links.js --dry-run | grep "docs/sdk/next"
```

**Why:** Verify before modifying. The script might already handle `next` since it scans all subdirectories.

---

## Step 8: Run Link Fixes (If Needed) 🔗

```bash
# First, dry-run to preview
node scripts/fix-sdk-relative-links.js --dry-run | grep -A 5 "docs/sdk/next"

# If looks good, run it for real
node scripts/fix-sdk-relative-links.js

# Check the changes
git diff docs/sdk/next/build/architecture/
```

**Why:** Always dry-run first. Review changes before committing.

---

## Step 9: Test Your Changes ✅

```bash
# Start the dev server
npx mint dev

# Navigate to: localhost:3000/docs/sdk/next/build/architecture/
# Click through several ADR links
# Verify:
# - Files load without errors
# - Links work (even if they go to other versions)
# - No broken syntax
```

**Why:** Manual testing catches issues automated tools miss. Actually use what you built.

---

## Step 10: Review Your Work 🔍

```bash
# See all changed files
git status

# Review all changes
git diff

# Check specific stats
git diff --stat

# Look at a specific file change
git diff docs/sdk/next/build/architecture/adr-033-protobuf-inter-module-comm.mdx
```

**Why:** Professional code reviews start with self-review. Catch your own mistakes first.

---

## Step 11: Commit with Clear Message 💾

```bash
# Stage the changes
git add docs/sdk/next/build/architecture/

# Write a descriptive commit message
git commit -m "fix(docs): Fix ADR links and syntax in sdk/next/architecture

- Copied corrected ADR files from v0.47 to fix Docusaurus syntax issues
- Ran link-fixing script to update relative links to full paths
- Links may reference v0.47 paths, to be cleaned up in future iteration
- All files now render without syntax errors

Fixes syntax issues mentioned in team sync.
Related to ongoing ADR formatting cleanup."
```

**Why:** Good commit messages explain WHAT changed and WHY. Future you (and teammates) will thank you.

---

## Step 12: Push and Create PR 🚀

```bash
# Push to your branch
git push origin neil/fix-next-adr-links

# Or if you worked directly on neil/adr-fixes:
git push origin neil/adr-fixes
```

Then create a Pull Request with:

**Title:** `fix(docs): Fix ADR links and syntax in sdk/next/architecture`

**Description:**
```markdown
## Problem
The `docs/sdk/next/build/architecture` ADR files had syntax issues from Docusaurus conversion
and broken relative links.

## Solution
- Copied corrected ADR files from `v0.47` to fix syntax
- Ran link-fixing script to update relative links to full paths
- Verified all pages render without errors

## Notes
- Links may reference `v0.47` paths temporarily
- Content is identical across versions
- Future iteration can update to version-specific links if needed

## Testing
- [x] Dev server runs without errors
- [x] ADR pages load correctly
- [x] Links are functional (even if cross-version)
- [x] No broken syntax
```

**Why:** PRs are documentation. Help reviewers understand your changes quickly.

---

## Step 13: Respond to Review Feedback 💬

When your colleague reviews:
- Address all comments
- Ask questions if something's unclear
- Push new commits (don't force-push unless asked)
- Mark conversations as resolved

**Why:** Code review is collaboration, not criticism. It makes everyone's code better.

---

## 🎓 Professional Best Practices

1. **Safety First**: Always branch, always backup
2. **Communication**: Check with team before big decisions
3. **Test Before Apply**: Dry-run, diff, review
4. **Clear Documentation**: Good commits and PR descriptions
5. **Incremental Work**: Fix what's broken now, perfect it later
6. **Validation**: Actually test what you built

---

## 📚 Common Pitfalls to Avoid

❌ **Don't:**
- Commit directly to `main` or shared branches without PR
- Skip testing "small" changes
- Write vague commit messages like "fix stuff"
- Force-push unless you know what you're doing
- Assume your changes work - always verify

✅ **Do:**
- Communicate with your team
- Test locally before pushing
- Write clear, descriptive commits
- Ask questions when unsure
- Break big changes into smaller PRs

---

## 🤔 Pre-Commit Checklist

1. ✅ Did I test this locally?
2. ✅ Does the dev server run without errors?
3. ✅ Did I check `git diff` for unexpected changes?
4. ✅ Is my commit message clear?
5. ✅ Would a new developer understand what I did?
6. ✅ Did I update/run any related scripts?
7. ✅ Are there any TODOs I should document?

---

## 🆘 Emergency Commands (If Something Goes Wrong)

```bash
# Undo last commit (keep changes)
git reset --soft HEAD~1

# Discard all local changes (CAREFUL!)
git reset --hard HEAD

# Go back to your backup branch
git checkout neil/adr-fixes-backup

# See what you did recently
git reflog

# Unstage files
git reset HEAD <file>
```

---

## 📞 Need Help?

- Ask your colleague in Slack/Discord
- Check git status: `git status`
- Check git log: `git log --oneline -10`
- Don't panic - git saves everything!
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading