Documentation, texinfo manual, readme generation #31
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
psionic-k
force-pushed
the
documentation
branch
11 times, most recently
from
2d97c15 to
2336df3
Compare
The documentation was moved to /doc and broken up so that there is now a manual and the README includes sections of the manual. The contributing guide was mostly left as-is. Table of contents no longer relies on org-toc Several helper commands to export and view the correct files were created. ERK now reads its own attributes to decide how to perform author renaming and also uses these during document generation The documentation generation was documented. Oh god. Lots of little documentation tweaks were done to format or support the exports. generated documentation found in new README.md, CONTRIBUTING.md, and manual.texi While considering how this will work for generic template repositories, it became clear that looking at ERK itself to figure out what to replace is not adding value, but it is adding overhead Signed-off-by: Psionik K <[email protected]>
Signed-off-by: Psionik K <[email protected]>
psionic-k
force-pushed
the
documentation
branch
from
9b0b20c to
2c42ef5
Compare
ERK is no longer a good demonstration project because it's getting too big. This also makes string replacement hard because if your derivative needs to retain instructions about using ERK, the clones get strings replaced that were needed for the instructions. Implementation was done by creating a template system and pointing it towards erk-basic, a stripped down ERK project with just one command and one test. Licenses are a bit annoying in this release. I want to go ahead and switch to a proper license package and take the licenses out of the templates. For now, the license had to be added to the erk-basic in order to maintain rough parity. Signed-off-by: Psionik K <[email protected]>
psionic-k
force-pushed
the
documentation
branch
2 times, most recently
from
719da50 to
514897c
Compare
Signed-off-by: Psionik K <[email protected]>
psionic-k
force-pushed
the
documentation
branch
from
514897c to
6b76f56
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See commit notes. Getting close to merging and just checking out CI to take a break.