hitchdev/hitchstory on Hacker News

…Example: https://hitchdev.com/hitchstory/using/behavior/run-single-na... Source: https://github.com/hitchdev/hitchstory/blob/master/hitch/sto... See also the explanation of self-rewriting tests: https://hitchdev.com/hitchstory/why/rewrite/

comment by Terretta · 2024-10-18 · in Unit tests as documentation

…example I built to exhibit the framework actually does this. Here's an example: https://github.com/hitchdev/hitchstory/blob/master/examples/... It records a video while running the test and then at the end runs it through FFMPEG to make a

comment by hitchstory · 2024-07-09 · in Docs as code (2017)

…framework around the ability to build these tests and then generate documentation from them. E.g. https://github.com/hitchdev/hitchstory/blob/master/examples%... which generates https://github.com/hitchdev/hitchstory/blob/master/examples%..…

comment by hitchstory · 2024-06-26 · in Documentation Driven Development (2022)

I built something like this too: https://github.com/hitchdev/hitchstory/blob/master/examples%...

comment by hitchstory · 2024-03-27 · in Winner of the SF Mistral AI Hackathon: Automated Test Driven Prompting

…"docs are tests and tests are docs" approach with integration testing when I created this library: https://github.com/hitchdev/hitchstory I realized at some point that a test and a how-to guide can and probably should actually be the same…

comment by hitchstory · 2024-02-13 · in Non-code contributions to open source

I have created a project for easily writing this type of test with YAML: https://github.com/hitchdev/hitchstory I dont think that this type of task is really appropriate for an LLM though. It is better to use hard, prewritten abstractions…

comment by hitchstory · 2024-02-12 · in Ask HN: Are there any LLM projects for creating integration tests?

…product, you won't know for certain. Test it and test it again. If you want to automate this, see: https://github.com/hitchdev/hitchstory It is not a common approach, but generating how-to docs from tests can be almost unreasonably…

comment by hitchstory · 2023-12-28 · in Docs Deserve More Respect

…I built this testing framework based upon autogenerating good how-to or reference docs from tests: https://github.com/hitchdev/hitchstory (the website example has screenshots generated by playwright, the REST API example has real tested…

comment by hitchstory · 2023-12-14 · in Should you add screenshots to documentation?

…to their projects run into a brick wall though - usually for one of the above reasons. I built https://github.com/hitchdev/hitchstory as an alternative that has straightforward syntax (YAML), very strict type safety (StrictYAML), low…

comment by hitchstory · 2023-10-09 · in How to add documentation to your product life cycle

…YAML integration tests. They autogenerate how-to markdown documents via a jinja2 template: https://github.com/hitchdev/hitchstory (there are a few toy examples listed there) Depending on the app the docs might also embed artefacts…

comment by hitchstory · 2023-09-18 · in Ask HN: How do you keep your technical docs in sync with code?

I built this because I had the same idea: https://github.com/hitchdev/hitchstory If your specification is self rewriting, can be tested and can be used to generate docs then maintenance costs plummet.

comment by hitchstory · 2023-09-11 · in Beyond OpenAPI

…I used this among other things to build some model integration tests which exhibit best practices: https://github.com/hitchdev/hitchstory/tree/master/examples/... I considered using tmpfs but since I wanted to cache the entire database…

comment by hitchstory · 2023-09-02 · in Optimizing Postgres's autovacuum for high-churn tables

…people generate evergreen markdown documentation from annotated type-safe YAML integration tests: https://github.com/hitchdev/hitchstory

comment by hitchstory · 2023-08-07 · in Elixir Livebook is a secret weapon for documentation

Like this https://github.com/hitchdev/hitchstory ?

comment by MoreQARespect · 2023-07-11 · in Docs as Code at Linode (2020)

…app screenshots) to generate readable how-to/tutorial docs which are guaranteed to stay up to date. https://github.com/hitchdev/hitchstory This isn't a new idea, but I find that people are often skeptical because there's a history of…

comment by hitchstory · 2023-06-12 · in The Surprising Power of Documentation

…has all of the benefits, fixes those 4 problems and doesnt suffer from traditional "YAML" problems: https://github.com/hitchdev/hitchstory I call this "BDD with meat".

comment by hitchstory · 2023-06-08 · in Ask HN: BDD and Gherkin tests, do they provide value in the real world?

Sounds like we had the same idea: https://github.com/hitchdev/hitchstory Like you I also dont want to go back. Declarative tests are the future.

comment by hitchstory · 2023-05-22 · in Ask HN: What's your favorite software testing framework and why?

If you like pytest and BDD I'd encourage you to check out my pytest library: https://github.com/hitchdev/hitchstory With it you can write integration tests with typesafe YAML which double as user friendly documentation. It also has…

comment by hitchstory · 2023-05-21 · in Ask HN: What's your favorite software testing framework and why?

…in docs autogenerated from tests. Especially with artrfacts embedded. They like tuff like this: https://github.com/hitchdev/hitchstory/blob/master/examples/... And can be persuaded to look at the (YAML) source. Gherkin isnt really a…

comment by hitchstory · 2023-05-16 · in A guidance language for controlling LLMs

Here's an example of it in action to run integration tests: https://github.com/hitchdev/hitchstory/tree/master/examples In e.g. the website example, the parent podman container does everything from running the integration tests to…

comment by hitchdev · 2023-04-26 · in How to use Podman inside of a container (2021)

I wrote a specification-test framework that does this: https://github.com/hitchdev/hitchstory Project with README that is partially generated from the code samples in the tests: https://github.com/crdoconnor/strictyaml with the README…

comment by pydry · 2020-11-27 · in Readme Driven Development (2010)

This is more or less the structure I followed with this testing framework: https://github.com/hitchdev/hitchstory The whole idea being that you don't want the story to be turing complete (there are no loops or conditionals with a story),…

comment by pydry · 2020-08-31 · in Yml Coding

This is kind of what I have been doing with this testing framework: https://github.com/hitchdev/hitchstory It's designed so that you can write tests that are the basis of the "how to" documentation - with a small script and some jinja2 you…

comment by pytester · 2018-12-13 · in Etsy’s experiment with immutable documentation