I think that is a good way to proceed.

from groonga.

Is there a purpose of having the same structure as this document and splitting the common parts?
If so, why not start by making contribution/documentation/introduction.rst the same structure, instead of splitting it up first?
It seems to me that this would make it easier to check common parts.

from groonga.

@abetomo
Thanks. I agree with your opinion because in this moment we are not sure splitting this document is better way.
I will update the current document and then think of the next step. How do you think of the following idea? If you agree with me, I will change the title and content of this issue.

doc: add steps for updating documentation to document contribution page

What is your problem?

As a new contributor, I find it challenging to understand the process for contributing updates to the Groonga documentation. It would be helpful for them to add following steps to introduction.rst.

• Editing the documentation
• Previewing changes
• Submitting changes

My suggestions

I propose to add a new sections to the introduction.rst about the documentation update process.

• Edit Documentation Sources
• Reflect Your Modifications
• Preview Your Modifications on HTML
• Update Translations
• Reflect Your Translations
• Preview Your Translations on HTML
• Send Pull Request to Groonga Repository

Next Steps after this issue

The content will be similar a little bit to the I18N page, but with a new flow.
We'll think about combining them after updating this introduction.rst.

from groonga.

Thanks! I've just updated the issue.

from groonga.