☂️ Umbrella issue for docs.

[merrcury]

Why contribute to Resuminator docs?

• Resuminator gives you the fastest and the smoothest resume building experience ever. With an intuitive user interface and a what-you-see-is-what-you-get (WYSIWYG) editor, you can create your first job-winning resume within minutes.

• Your very chance of experiencing docs composed from scratch, rephrase, from code to human language on a popular career and community project

• Enjoy the pleasure of finding things out, teach and share them with others, practice writing skills

• Maybe, We'll feature you in our newsletter, Broadmap

List of doc pieces up for grabs:

User Guide

These guides shall help the users in using the software smoothly and onboard on Resuminator much faster.

• Home Page (assigned to @louremipsum )
• Create Page
• Design Page
• Download Page
• Settings Section

Feature Docs

These pieces of documentation explain a feature, how users can benefit from it, and how to use it for their resumes (along with any other relevant information)

• Multiple Resumes
• One/Two Columns
• Social Handles
• Detailed Sections (like Education, Experience, Publications etc)
• Custom Sections
• Design Controls (Font, Spacing, Color, Grayscale Mode)
• Grammarly Integration (using Chrome Extension)
• Profile Images in Resumes

Dev Task for Docs Repo

These tasks require knowledge of git, docusaurus and Javascript.

• Setup pre-commit hook for markdownlint-cli

Examples

We would like to provide inspiration to users on how they can make different Resume templates by mix and matching the features available.

• Adding Voluntary Work/Achievements using Custom Section
• Displaying Open Source Work with Custom Section
• Creating a new kind of Skills Section with Custom Section
• Adding Portfolio links with custom social handles

Working on a doc piece

• Our docs are in the very initial stage. So, there are no hard guidelines.
• You just need to keep your vocabulary simple. So, People new to English can also understand what is being conveyed.
• Next is linting. We take linting seriously. So, see the setup for linting in docs (Your PR might fail linting checks if guidelines are not being followed). You can use this VS Code Extension to identify linting errors
• Currently, We don't accept docs issues in the legal section apart from typos.

Adopting a doc piece

• Create a PR and reference this issue
• Within your PR, mark clearly which piece you are working on
• Once we see your PR, we'll mark in this issue that the corresponding piece is under work in progress by you
• If you don't feel like continuing working on the piece, close the PR so that other people can pick it up
• Each piece is to be solved in a different PR
• Only one piece at a time can be worked on

Note that:

Your initial work does not have to include all the content for the piece, put WIP to indicate that you are working on it
You don't need to ask for permission or progression, etc. As long as there is no open PR (we will mark it beside the section), you can pull one up for the piece you are working on

Have you read Code Of Conduct?

By interacting with this issue, you give affirmation on an agreement to same. You can respond with 👍🏼 just to let us know.

[louremipsum]

I would like to work on a user guide for different pages like Home, Create etc.
@merrcury @viveknigam3003 Could you please add it to the list?

[louremipsum]

hey, @merrcury @viveknigam3003 I was thinking of making a guide page for helping new users who want to contribute to docs regarding the tools, various tricks etc. which I learned when making the docs/previously known.
what are your thoughts?

[merrcury]

Hey @louremipsum I don't see a value add for Resuminator Docs but You can have a separate repo like this