drym-org / old-abe

Accounting prototype for attribution-based economics
6 stars 2 forks source link

Add starter docs #10

Closed countvajhula closed 1 year ago

countvajhula commented 1 year ago

Summary of Changes

For docs, I considered Markdown (too limited), reStructuredText (more flexible but idiosyncratic), Texinfo (even more flexible but obscure), and Scribble (most flexible but obscure). I think we should try Scribble since in principle it's the most flexible, although it doesn't have as much adoption as some of these other options, while being newer and actively developed unlike Texinfo.

To build it:

$ scribble oldabe.scrbl

... generates HTML output.

Public Domain Dedication

(Why: The freely released, copyright-free work in this repository represents an investment in a better way of doing things called attribution-based economics. Attribution-based economics is based on the simple idea that we gain more by giving more, not by holding on to things that, truly, we could only create because we, in our turn, received from others. As it turns out, an economic system based on attribution -- where those who give more are more empowered -- is significantly more efficient than capitalism while also being stable and fair (unlike capitalism, on both counts), giving it transformative power to elevate the human condition and address the problems that face us today along with a host of others that have been intractable since the beginning. You can help make this a reality by releasing your work in the same way -- freely into the public domain in the simple hope of providing value. Learn more about attribution-based economics at drym.org, tell your friends, do your part.)

countvajhula commented 1 year ago

FYI @apromessi @jairtrejo

countvajhula commented 1 year ago

We have hosted docs now 😄

https://drym-org.github.io/old-abe/

They get built as part of CI as configured in this workflow. I approximately followed this recipe to set it up -- in a nutshell, this builds the docs and puts the HTML output in a gh-pages branch, which GitHub already recognizes as the interface to the repo's corresponding Pages site that Github provides hosting for, so once the HTML files end up there, they get pushed to the site.

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 4703831472

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details


Totals Coverage Status
Change from base Build 4685751696: 0.0%
Covered Lines: 58
Relevant Lines: 220

💛 - Coveralls