Documentation is like sex...



  • …when it’s good, it’s very, very good; when it’s bad, it’s better than nothing.

    As you can see, Notepad++ Wiki’s content is very outdated. For the security reason, Notepad++ Wiki is in read only currently, and it will be replaced by new Notepad++ User Manual (from scratch).
    Notepad++ User Manual will be built collaboratively (in Markdown) on GitHub. So anyone can contribute it by submitting the pull requests.

    The main sections (the structure of this user manual) that I can enumerate for the moment are:

    • Introduction
    • Getting start
    • Programing Languages
    • User Defined Language System
    • Searching
    • Session
    • Macros
    • Auto-completion
    • Plugins
    • Preferences
    • Themes
    • Command Line
    • Shell Extension
    • Binary Translation
    • Updating

    [Edited 23/05/2019]
    I need your vision for this define to cover Notepad++ in every aspect.
    notepad-plus-plus/npp-usermanual is reloaded and it will be used as the Notepad++ document official repository:
    https://github.com/notepad-plus-plus/npp-usermanual/

    The party begins. You’re contribution (PR) are welcome!



  • That’s awesome. Thanks, @donho! Is it going to be in the existing notepad-plus-plus/npp-usermanual repo, or starting over?

    One thing I really like in user manuals is to have a section on configuring / setting preferences. So in your section outline, I’d probably call it

    • Preferences

    and put it after the Themes

    With highly configurable apps, like Notepad++, it’s often hard to remember where a given setting is, so having a single page which enumerates the location of each of the settings, as well as gives a brief description of each, would be quite useful.

    Other than that, I am sure as people contribute, new sections will be thought of. That outline is a great starting point. I look forward to contributing.

    Thank you.



  • @PeterJones said:

    Is it going to be in the existing notepad-plus-plus/npp-usermanual repo, or starting over?

    Starting over. “notepad-plus-plus/npp-usermanual” repo will be removed.

    • Preferences

    Added now. Thanks.



  • @PeterJones

    Is it going to be in the existing notepad-plus-plus/npp-usermanual repo, or starting over?

    Starting over. “notepad-plus-plus/npp-usermanual” repo will be removed.

    A little bit change:
    notepad-plus-plus/npp-usermanual is reloaded and it will be used as the Notepad++ document official repository:
    https://github.com/notepad-plus-plus/npp-usermanual/



  • @donho
    What about using GitHub Page: GitHub Pages is designed to host your personal, organization, or project pages from a GitHub repository.
    Here is an example of my fork :
    https://cmeriaux.github.io/npp-usermanual/SUMMARY



  • @cmeriaux

    many thanks for your thoughts, they are the same which we had at the beginning, of using github pages and the jekyll engine, due to the easy-cheesy setup.

    but currently we prefer to set up an in-house solution, that we can change to our needs anytime, without external dependencies.

    best regards



  • It’s not so “in-house”. In fact we use Hugo (another popular MD to HTML generator) to render our document.
    The “in house” part is each merge of PR into npp-usermanual master will update automatically the document site on the fly. So the document site in question cannot be in github.io if we want to have this feature.



  • @donho

    each merge of PR into npp-usermanual master will update automatically the document site on the fly. So the document site in question cannot be in github.io if we want to have this feature.

    the github pages jekyll engine renders all md files of a repo on the fly, that’s why we’ve first suggested it, to get the doc up and running as quickly as possible.

    It’s not so “in-house”

    yes, it’s not quite in-house, as long as we use the ovh server.
    but as long as no-one sponsors a datacenter to notepad++ we will not be able to do everything in-house. 😉


Log in to reply