Git Product home page Git Product logo

Comments (5)

qwel-exe avatar qwel-exe commented on September 23, 2024

hey could i do this

from auto-pairs.

LunarWatcher avatar LunarWatcher commented on September 23, 2024

Sure!

from auto-pairs.

qwel-exe avatar qwel-exe commented on September 23, 2024

The docs have grown pretty fast, and gotten a bit messy; double-checking everything for accuracy, as well as shortening and re-writing for style, grammar, and clarity is needed.

It's primarily AutoPairs.txt in the doc directory that needs to be updated; it contains a lot of old text that I haven't focused on when doing other stuff. The things that need to be done are;

  • Spell-check and verify the readability of both the documentation files
  • Ensure technical accuracy in AutoPairs.txt, wrt. updates making certain parts obsolete
  • Changing the style in AutoPairs.txt, if necessary to improve readability
  • Making stuff easier to find in AutoPairs.txt

Also note that this is a lot for a single PR, so anything fixing or working on parts of this are fine; there's a lot of text to go through, and a lot of stuff to improve, so partial pull pull requests are obviously fine.

hey a small thing insted of using .txt we can use .md

from auto-pairs.

LunarWatcher avatar LunarWatcher commented on September 23, 2024

Using txt is a Vim convention; https://vimhelp.org/helphelp.txt.html#help-writing

The files in question are also accessible from inside Vim, which is why they're formatted the way they are. The link also includes the format details.

Switching to markdown would require a lot more work, because we'd realistically need to make an entire standard for tags and whatnot, and somehow make it work when distributed, and I'd rather not reinvent the wheel with this particular problem. See: https://www.reddit.com/r/vim/comments/dxmpa6/writing_tagged_documentation_in_vim/

from auto-pairs.

LunarWatcher avatar LunarWatcher commented on September 23, 2024

You can still work on this, I just realized a bit after the fact that assigning people to an issue this open-ended doesn't particularly make sense :')

from auto-pairs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.