prezto
prezto copied to clipboard
sorin-ionescu
Proposed enhancements to runcoms repo documentation
Mitigates #1535
Proposed Changes: Detailed documentation for runcoms Discussion about the most common pitfalls (no screenshot available, it is a repo Markdown file...)
To anyone interested in reviewing this, it's easiest to look at here: https://github.com/hlecuanda/prezto/blob/5d2b2a776e3ae1145c25d147869371c3ddf1b274/runcoms/README.md
I believe you're quite right, sometimes less is more.. If however you feel the longer writeup could be valuable for users and the team, I'd be glad to post it perhaps in the project's wiki? I've incorporated your remarks. This new version touches on the issues of configuration in a way that is positive for both schools of thought regarding copying or merging of runcoms; without digressing on the finer points of bootstrapping flows and how parameters affect them :laughing: (i admit i get carried away) Now, back to holiday in MX hehe.
Any chance you could allow maintainer edits? I've got a few smaller things I'd like to fix up before merging this in.
um.... unless i'm missing something, maintainers should be able to edit... the "allow edits from maintainers" option is ticked on this screen... =)
Unfortunately, only sorin has admin access to the repo, so I don't think I can actually enable the wiki without him getting involved, so I'd rather avoid that for now.
With triaging issues and PRs, I'd be happy to have some additional help. I've been very slowly going through them in my spare time, but I haven't much lately. The ones that are left are (for the most part) issues that I'm not sure what to do about, but there's definitely still stuff to do. There are a few things to keep in mind, though: new themes and modules can be pointed at the contrib repo (we're trying to avoid merging those in here for now) and any large/breaking changes need to have a really good reason. This is still sorin's project and one of his goals was to avoid this turning into a giant mess with hundreds of modules. Thanks for offering to help!
Additionally, I'm going to be out for at least the weekend so it might be a while until I make my way back to this.
agreed! i guess the rule of thumb is, universal features such as syntax highlighting or performance enhancements (such as troubleshooting compdumps should live here, in core. Vertical, narrow functionality (say bindings and aliases for Ansible) clearly should resde in "/contrib" i'll see what i can do regardng some issues that can be resolved as support issues,,,
Sorry didnt realise I made a horrible mes with the table. Fixed it and some embarrasing typos... here is the link to the write-up: https://github.com/hlecuanda/prezto/blob/5ec8ce51751673bbb4e3f1c1d84858ea48fd21e5/runcoms/README.md