Documentation help wanted

[Vimux]

Hello everyone!

I'm not that good at explaining and writing, so I need help with documentation.

The overall idea is to fix typos and errors, simplify and streamline the content, add missing parts(?). Key point: don't describe what Hugo can do, describe what Mainroad theme can do. In other words, our documentation will mainly cover things unique to Mainroad.

Documentation pages:

• exampleSite/content/docs/getting-started.md [Update getting-started.md #285]
• exampleSite/content/docs/customization.md
• exampleSite/content/docs/faq.md [Update faq.md #283, Update faq.md #286, Update faq.md #290]
• exampleSite/content/about.md

Important pages:

• README.md
• CONTRIBUTING.md

If someone has (technical) writing skills and wants to help me out there, any help is much appreciated!

P.S. As always, I'm open to any feedback on the overall plan or details.

[Ashwani-Verma-07]

hi ,@Vimux can you assign this issue to me

[Vimux]

@Ashwani-Verma-07,

No problem, I can assign you to this issue, but please let me know what you plan to do: fix typos, rewrite something, add missing parts? What files do you want to work on which are listed above in the issue description?

Other potential contributors and I will be able to take this into account and plan our future tasks accordingly.

[Ashwani-Verma-07]

yes i will look out all errors related to fix typos, grammatical error on exampleSite/content/docs/faq.md

[lisa005]

Hello! I'm fairly new here, but I'd like to help edit the Getting Started and FAQ sections for conciseness, grammar, and typos.

[Vimux]

@lisa005,

Good, any help is welcome. I assign you.

Tip: read CONTRIBUTING#pull-requests-pr.

[rmcf]

Hi @Vimux I am grateful for Mainroad theme and would like to suggest Ukrainian localization for user interface. Is it interesting for you? Also, I have a question about “search” widget – should I create an issue or may I ask it here? I am very new in Hugo and don’t know how to configure it correctly to search my posts by title.

[Vimux]

@rmcf,

I am grateful for Mainroad theme and would like to suggest Ukrainian localization for user interface.

Go ahead. Please read CONTRIBUTING.md first. It will help you avoid most problems.

I may be slow to respond in the coming days, but I will look into it as soon as I have time.

Also, I have a question about “search” widget – should I create an issue or may I ask it here? I am very new in Hugo and don’t know how to configure it correctly to search my posts by title.

The widget redirects the user's query to the search engine, limiting the search to the site. I do not provide free technical support, so your specific personal question will remain unanswered no matter which of these two actions you take. Our issues are for bug reports and feature requests only.

[richard-salam]

Hey @Vimux I'd love to help with any technical documentation. :)

[Vimux]

@richard-salam,

Better documentation is a good thing. Do you have something in mind? It would be better if we discussed it briefly before you invest your time.

[richard-salam]

@richard-salam,

Better documentation is a good thing. Do you have something in mind? It would be better if we discussed it briefly before you invest your time.

I agree @Vimux I am available on LinkedIn https://in.linkedin.com/in/richardsalame Please ping me there, let us discuss :)