Pick up what's in the Writer's Guide and use?
thoni56 opened this issue · comments
There is a very preliminary Author's Guide in the source (in Writing.odt) uploaded to website under Development Snapshots, perhaps somethings in it might be valuable. We should look through that and save what's valuable before removing it from the source tree and uploads.
I actually had already converted all three documents to Asciidoc, and sent them to you in the past.
I can add them to the Manual folder in the Alan-Docs project, so we can easily copy and paste the required parts and edit them.
Oh, sorry about that. As you can see, my alan work intensity is below the threshold of remembering things... But I'm trying to spend some more time on it for a while.
I didn't find the Author's Guide in the alan-docs project, so I thought they were not handled. Perhaps we should store them there, just to know where they are? And then it is easier to copy paste for anyone.
I was mistaken, I've converted only the ALAN design documents — which I've now added to the Beta7 work branch, in case we need to reuse some of their material.
But I can start working on the conversion of the Writing guide from ODT to AsciiDoc, and give it a rough polish. Then we can polish the parts that we decide to reuse, as we go along.
Right now, having an AsciiDoc draft of the Writing guide in the repository (Beta7 branch) could help us discuss what to recycle.
Porting Work Started
I've began porting the Alan Author's Guide to AsciiDoc, in a dedicated writing-guide branch:
https://github.com/alan-if/alan-docs/tree/writing-guide/writing
The document isn't huge, so it's worth porting it fully, and align it to the stylistic guides of the repository, so that it can then be further developed directly in the Alan Docs project.
Once it's nicely polished, we can merge it in master branch.
Porting Work Ready
@thoni56, I've completed porting the Alan Author's Guide to AsciiDoc, and fixed all the styles according to the standards of this project.
I say that we should merge it into the master branch, if that's OK with you.
If you confirm, I'll do another quick check that everything is in place and then squash-merge it.
Nice. Yes, please merge. There is nothing conflicting there and we should keep the number of branches low. Thanks.
The preview links in the README for it seems to be wrong. (Didn't want to create an alan-docs issue for this ,-)
Which is link is that? I can't find it.
Maybe it was fixed with the merge into master now?
Anyhow, I've squashed and deleted the writing-guide branch.
I couldn't find the broken link, they seem to work all fine now that it's merged. If you still find the link to be broken just drop some more info on which link is that, otherwise you can close the issue.
I have to run to a dinner with friends right now (