New Docs

37 views
Skip to first unread message

Alen Šiljak

unread,
Apr 21, 2019, 3:29:59 PM4/21/19
to Beancount
First, I'm not sure if this is a good idea with mixing user and developer topics but I believe there is only one group (for everything)?

Since Martin sent me the link to the new (.md) docs repo, could anyone else familiar with the current state of ideas, shed some light about the process? You know, the things that usually go into the ReadMe.
I've seen it mentioned in another thread and the Python script seems to be doing the job. What help exactly would be useful in converting the docs?
I'm happy to help there. In particular since I'm new to Beancount and am at the stage where I'm just running the samples and parts of my book, to see the inner workings, while going through a lot of documentation. It's a perfect stage to contribute to the docs from the perspective of a newcomer, before I move to more advanced stuff and coding.

It's a refreshment to see a lively community.

Martin Blais

unread,
Apr 21, 2019, 6:06:54 PM4/21/19
to Beancount
On Sun, Apr 21, 2019 at 3:30 PM Alen Šiljak <alen....@gmx.com> wrote:
First, I'm not sure if this is a good idea with mixing user and developer topics but I believe there is only one group (for everything)?

It's fine. Small group of people, not worth splitting just yet (and probably forever, I can't imagine text files for accounting going mainstream anytime soon).


Since Martin sent me the link to the new (.md) docs repo, could anyone else familiar with the current state of ideas, shed some light about the process? You know, the things that usually go into the ReadMe.

There's only one script.
This isn't a project of its own, really, so there's no README, I just  created a repo after a quick attempt at prodding at the new-ish Google Docs API.  Another user on the list mentioned it, and I wrote a script to hit the API and download all the docs in JSON format locally (see *.json files in that directory) and the convert_docs_json_to_markdown.py script is used to convert all of them to their corresponding *.md files without having to use the API. You can just run that, and iterate until the markdown files have the right content if you feel like it.

 
I've seen it mentioned in another thread and the Python script seems to be doing the job. What help exactly would be useful in converting the docs?

Lots to do:
- contents aren't correct sometimes (compare with real doc, you'll find lots of differences)
- images aren't inserted, converted
Reply all
Reply to author
Forward
0 new messages