https://pgsty.github.io/oink-starter/docs/introduction/Recent content in Introduction on Project NameHugoen-USFri, 28 Aug 2026 20:20:24 +0800https://pgsty.github.io/oink-starter/docs/introduction/overview/Mon, 01 Jan 0001 00:00:00 +0000https://pgsty.github.io/oink-starter/docs/introduction/overview/<p>Replace this page with the shortest useful explanation of your project.</p> <h2 id="problem">The problem </h2> <p>Describe the problem in the reader’s language. Avoid implementation details until the reader understands why the project matters.</p> <h2 id="outcome">The outcome </h2> <p>Explain what a successful user can do after adopting the project.</p> <div class="td-callout td-callout--tip" role="note"> <div class="td-callout__title"><i class="td-callout__icon fa-solid fa-lightbulb" aria-hidden="true"></i><span class="td-callout__label">Tip</span></div> <div class="td-callout__body"> <p>A strong overview helps readers decide whether to continue in less than two minutes.</p>https://pgsty.github.io/oink-starter/docs/introduction/architecture/Mon, 01 Jan 0001 00:00:00 +0000https://pgsty.github.io/oink-starter/docs/introduction/architecture/<p>Document the few components a contributor must understand before making a change.</p> <h2 id="system-map">System map </h2> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Part</th> <th scope="col">Responsibility</th> </tr> </thead> <tbody> <tr> <td>Interface</td> <td>Accepts user input and presents results</td> </tr> <tr> <td>Core</td> <td>Applies the project’s rules</td> </tr> <tr> <td>Adapters</td> <td>Connect external systems</td> </tr> </tbody> </table> </div> <h2 id="boundaries">Boundaries </h2> <p>Name what the project deliberately does not own. Clear boundaries prevent documentation from promising more than the software provides.</p>