My workflow for contributing to documentation, to avoid issues! (Manual)

[ylevental]

Edit: Easier way! https://claude.ai/code/

I'm working on a Codecademy Docs contribution. Follow this exact workflow:

ISSUE DETAILS:

• Issue #: [FILL: e.g., 7815]
• Library/Concept: [FILL: e.g., matplotlib, PyTorch, NumPy]
• Method/Function: [FILL: e.g., .axis(), .igamma()]
• Issue URL: [OPTIONAL: paste GitHub issue URL]

MY SETUP:

• System: Fedora 43
• Docs repo location: ~/Documents/docs
• GitHub username: ylevental
• My fork: https://github.com/ylevental/docs

WORKFLOW YOU MUST FOLLOW:

Before doing anything else, ask me if this is the first time on this computer. If not, skip to PHASE 1. Otherwise, Proceed

SETUP (FIRST TIME ONLY, re-print the entire block):

rm -rf ~/Documents/docs
cd ~/Documents
git clone https://github.com/ylevental/docs.git
cd docs
git config --global user.name "Yuval Levental"
git config --global user.email "[email protected]"
git remote add upstream https://github.com/Codecademy/docs.git
yarn install # Only needed first time!
git fetch upstream
git merge upstream/main
git push origin main

PHASE 1 - Clean Start (I'll run these, after you edit last line and re-print the entire block):

cd ~/Documents/docs
git checkout main
git pull origin main
git fetch upstream
git merge upstream/main
git push origin main
git checkout -b add-[feature-name]

Before Phase 2, check if filesystem is enabled. Also ask me if I ran Phase 1 yet. If yes, continue.

PHASE 2 - YOU INVESTIGATE FIRST:
Before creating ANY files:

1. Use Filesystem:search_files to locate the concept directory
2. Use Filesystem:directory_tree to examine structure
3. Check 2-3 existing term files to understand the pattern
4. VERIFY the concept file already exists (e.g., matplotlib.md, pytorch.md)
5. Tell me the EXACT path where the new term file should go
6. Show me the directory structure you found

PHASE 3 - YOU CREATE FILE:

1. Create the complete .md file with:
   • YAML front matter
   • Description
   • Syntax section
   • Example section
   • Codebyte example
2. Create it in the CORRECT location you verified in Phase 2
3. Give me the exact commands to format and push

PHASE 4 - I FORMAT & PUSH:
I'll run the commands you give me.

PHASE 5 - PR TEMPLATE:
Give me the complete PR title and description with the CORRECT file path.

CRITICAL RULES:

• ALWAYS check existing structure BEFORE creating files
• NEVER assume file locations
• ALWAYS use Filesystem tools to verify paths
• The concept file (e.g., matplotlib.md) must already exist
• Format with: yarn prettier --write [file-path]