Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"cSpell.words": ["antifragile", "replayable"]
}
69 changes: 36 additions & 33 deletions docs/docs-intro/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,58 +4,61 @@ sidebar_position: 1

import Badge from "@site/src/components/Badge";

# Note on the Docs
# Support NeoHaskell

NeoHaskell is an ongoing effort that is yet in an early development stage. Throughout the documentation you might find badges like the following: <Badge issue="57"/>
## Building the Future, One Event at a Time

**Try hovering your mouse over it!** (and if you click on it, it will take you to the GitHub issue that's tracking the implementation).
Hi, this is Nick, the creator of NeoHaskell.

This badge means that this feature is **documented but it is not implemented.** This is on purpose.
NeoHaskell exists because we believe software development doesn't have to be painful. That adding your 100th feature should be as easy as your first. That teams should stay small and happy even as systems grow massive.

We believe that the documentation is the central part of any good
development experience, therefore we first write the documentation, and
only then, we implement the required things to make the feature defined
in the documentation possible.
Right now, I'm working on NeoHaskell full-time, living off my savings to make this vision real. Every contribution—whether financial, technical, or spreading the word—directly impacts how fast we can deliver a world where technical debt becomes obsolete.

One of the primary statements of NeoHaskell is:
## Ways to Support

:::tip If it takes more than 15 minutes to figure out, it is a bug
:::
### Financial Support

This doesn't apply only to the command line tool, libraries, and so on, but also **to the documentation itself**.
Choose the platform that works best for you:

## Requesting Clarification
- **[GitHub Sponsors](https://github.com/sponsors/NickSeagull)** - Direct support through GitHub
- **[OpenCollective](https://opencollective.com/neohaskell)** - Transparent collective funding
- **[Ko-fi](https://ko-fi.com/nickseagull)** - One-time or monthly contributions

If you find yourself reading some part in the documentation and you're having trouble understanding it, click on the
**Edit this page** button on the bottom left of the page, and the GitHub repository with that page will open.
Every dollar extends the runway. Every month of runway means more features, better documentation, and a stronger foundation for the companies that will build their future on NeoHaskell.

Click on the top right pencil icon to open the editor.
### Hire Me

![pencil location](img/02-pencil.png)
The best way to support NeoHaskell? **Use it in production.**

In that editor, mark the part that you find unclear. You can use any kind of marker that you want, as long as it marks well the part you're not clear about. For example:
I'm available for consulting to help your team:
- Architect event-driven systems that actually work
- Transition from CRUD to event sourcing without the pain
- Build your next product with NeoHaskell
- Train your team on event modeling and domain-driven design

```text
--->>> some documentation sentence <<<--- rest of documentation....
```
When you hire me, you're not just getting consulting—you're funding NeoHaskell's development while solving your own technical challenges. Every production use case makes NeoHaskell stronger.

Once you finished, click on the big green button on the top right, select "Create a new branch for this commit and start a pull request" and click on propose changes:
**[Contact me for consulting](mailto:consulting@nickseagull.dev)**

![propose changes explanation](img/02-propose-changes.png)
### Other Ways to Help

A screen will appear, fill it with the title of your request and some description on what could help you understand this better.
**Use It**: Build something with NeoHaskell. Your feedback shapes what we build next.

![pull request](img/02-pull-request.png)
**Share It**: Tell others who are suffering from exponential complexity. Write about your experience. Show what you've built.

Click on **Create Pull Request**, someone from the contributor team will be notified about this, so the section can be
clarified.
**Contribute**: Code, documentation, examples—every contribution matters. We're building this together.

## This is Important
**Star It**: Give us a star on [GitHub](https://github.com/neohaskell/neohaskell). It helps others discover the project.

This process helps everyone to maintain a great documentation that everyone can understand, and these are actually the
most important contributions, as when you have experience and knowledge about any topic it is very easy to miss on the
actual details that newcomers can find daunting.
## Why This Matters

![documentation beats conversation](img/docs-beat-convo.gif)
Your support isn't just funding a programming language. You're investing in a future where:

Thanks for reading this part! Now onwards to learn NeoHaskell!
- Startups don't fail from technical bankruptcy
- Developers don't burn out from complexity
- Companies scale without suffering
- Software development becomes humane again

Together, we're proving that software can get better, not worse, over time.

**Thank you for believing in this vision.**
5 changes: 0 additions & 5 deletions docs/essentials/_category_.json

This file was deleted.

91 changes: 0 additions & 91 deletions docs/essentials/constants.mdx

This file was deleted.

Loading