Skip to content

wolf-math/wolfcodes_docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WolfCodes Documentation

Technical documentation for WolfCodes — a learning platform focused on turning complex programming concepts into clear, structured understanding.

“Turning Complexity into Clarity.”


Overview

This repository contains the source code for the WolfCodes documentation site, built with Docusaurus.

The goal of this project is to provide:

  • Structured learning paths for developers
  • Mental-model-first explanations
  • Progressive difficulty from fundamentals to advanced topics
  • Language-specific guides and references

Unlike traditional documentation, WolfCodes is designed to teach, not just describe.


Philosophy

Most documentation answers:

“What does this do?”

WolfCodes focuses on:

  • Why it works
  • How to think about it
  • When to use it

This repository reflects an educational approach grounded in real teaching experience, not just API reference writing.

Viewing the Site

The live site is available at:

https://wolfcodes.dev


Built With

  • Docusaurus
  • React
  • MDX
  • Prism (syntax highlighting)
  • KaTeX (math rendering)

Writing Content

Content is written in Markdown / MDX.

Before contributing, please review the style guide:

  • style_guides/technical_guide.md (core philosophy and structure)
  • Additional style guides in the style_guides/ directory

General principles:

  • Teach concepts, do not just define them
  • Prefer examples over abstraction
  • Build from simple to complex
  • Do not assume prior knowledge unless explicitly stated

Contributing

Contributions are welcome and encouraged.

If you notice unclear explanations, missing examples, or structural issues, you can suggest changes directly through GitHub.

Recommended Workflow

  1. Navigate to the file you want to edit
  2. Click the “Edit” (pencil) icon
  3. Make your changes in the browser
  4. Submit a pull request with a clear description of the improvement

Before submitting changes, please make sure they align with the style guide in the style_guides/ directory.

You can also open an issue to:

  • Report unclear or confusing sections
  • Suggest new topics or guides
  • Propose structural improvements

There is no need to clone the repository or run the project locally unless you prefer to.


License

Content is licensed under:

Creative Commons Attribution-NonCommercial 4.0 (CC BY-NC 4.0)


Author

Created by Aaron Wolf

  • Full-stack developer
  • Math educator
  • Technical writer

Vision

This project is part of a broader goal:

Build the kind of documentation that actually teaches people how to think like developers.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors