Giter VIP home page Giter VIP logo

guides's Introduction

MenuDocs Official Written Guides.


Why a written guide from MenuDocs?

MenuDocs is an organisation dedicated to providing educational resources for its community and other. We value every single person and the way they best learn. Which brings us to the point that we acknowledge that fact that everyone learns different whether thats following video tutorials better, or following written tutorials better.

How can you contribute to this growing guide?

A simple PR request is one step closer to displaying your guide on our website. All credits are given where due which means you're able to display your github redirect at the top of all your guides. We advise that you join the discord to get better help with implementing your guide which you can find above.

Can I contribute to improving the theme used on the website?

You sure can! You'll be able to find the theme we use on a repository displayed on our github.

How to create a guide?

  1. Fork the guides repo here: https://github.com/MenuDocs/guides
  2. First create your folder in here: https://github.com/MenuDocs/guides/tree/master/guide/topics
  3. Then head on over to here to add your sidebar: https://github.com/MenuDocs/guides/blob/master/guide/.vuepress/components/Sidebar.js
  4. You'll need a base README.md in the file which will be the "fallback" file. you can reference the other current guides for more information.
  5. Any images you would like to have will need to go in a folder displayed here: https://github.com/MenuDocs/guides/tree/master/guide/.vuepress/public/images. You can then access them like "/images/nameOfFolder/image.png"
  6. You will only need to have 1 category (the programming language used or the service used. "How to setup a VPS for Node.js" or "Introduction to Frontend Development" are examples of a name.) displayed in the README aswell as any legitimately related tags (frameworks, libraries, development type), this can be seen here: https://raw.githubusercontent.com/MenuDocs/guides/master/guide/topics/discordjs/README.md
  7. Structure your guide, split your guide into Subheadings which ultimately can be subpages.
  8. Review your guide to make sure it's factual, straight to the point with all the valid information required and overall has great use of the English language.
  9. Add yourself and anyone that helped as an author. Note that the way our guide is designed is the author your provide must be a valid github user.
  10. Create a Pull Request to the original repo which will allow it to be review and ultimately merged
  11. Kachow, you're on the guide! Thank you for contributing.

guides's People

Contributors

acollierr17 avatar booleans-oss avatar jonasschiott avatar melodicalbuild avatar nortex-dev avatar solaris9 avatar strandable avatar strandxo avatar

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.