[IMP] contributing/documentation: update documentation guidelines #10675
Conversation
|
|
auva-odoo
force-pushed
the
15.0-doc-guidelines-auva
branch
from
b2d8f4f to
71985d7
Compare
|
Hello @dade-odoo and @xpl-odoo, here is a first draft of the updated documentation guidelines. When you get a chance, could you please take a look and let me know if everything looks good to yoy and if I missed anything? Thank you guys! |
auva-odoo
force-pushed
the
15.0-doc-guidelines-auva
branch
from
71985d7 to
dfe9476
Compare
There was a problem hiding this comment.
@xpl-odoo @dade-odoo I force-pushed most of the changes but I still have a few I want to make. I'll let you know when it's ready for review (again) 🙂
|
|
||
| .. _contributing/documentation/first-contribution: | ||
| .. _contributing-documentation-first-contribution: | ||
|
|
||
| Make your first contribution |
There was a problem hiding this comment.
I changed this one but noticed that we actually have a bunch of these in the rst_guidelines as well 🙈 They're not so easy to change though as we made the actually instructions into headings. However, you have solid point when you say we should respect the guidelines in the guidelines. What do you think?
Edited: I changed them
auva-odoo
force-pushed
the
15.0-doc-guidelines-auva
branch
from
dfe9476 to
98bf33c
Compare
|
@xpl-odoo @dade-odoo ready for you to review (again) 🙂 |
auva-odoo
force-pushed
the
15.0-doc-guidelines-auva
branch
from
98bf33c to
220baf4
Compare
There was a problem hiding this comment.
@auva-odoo thanks for your patience! Happy to discuss any of the points further with you :)
auva-odoo
force-pushed
the
15.0-doc-guidelines-auva
branch
from
220baf4 to
a7ff8d8
Compare
auva-odoo
force-pushed
the
15.0-doc-guidelines-auva
branch
2 times, most recently
from
16c8d52 to
ecaa120
Compare
|
Hi @StraubCreative I've made the changes to the documentation guidelines as discussed (through Dallas). I'd appreciate it if you could take a look and share your thoughts 🙂. Thank you! |
xpl-odoo
force-pushed
the
15.0-doc-guidelines-auva
branch
from
ecaa120 to
6f778ac
Compare
There was a problem hiding this comment.
Hi @auva-odoo
This is so great to see, thank you for putting this together 🙏
I still have more to look at after the Content guidelines > Capitalization section, however here are some comments below for your consideration. I hope you find them helpful and please let me know if you want to discuss anything more in particular.
Thanks again and talk more soon!
auva-odoo
force-pushed
the
15.0-doc-guidelines-auva
branch
from
6f778ac to
3841ee4
Compare
|
Hi @StraubCreative, thank you so much for taking the time to start reviewing this PR! 🙏 I've already implemented most of your initial suggestions. Do you think you’ll have time to go through the rest by the end of September? We’re aiming to have the updated guidelines live after OXP, and your input would be much appreciated 🙂 |
There was a problem hiding this comment.
Hi @auva-odoo
From where I left off, I think the rest of the doc looks good. I just have a few optional suggestions for your consideration here, otherwise I think we're good to go! 🚀
Thank you!
auva-odoo
force-pushed
the
15.0-doc-guidelines-auva
branch
from
3841ee4 to
1412561
Compare
|
@robodoo r+ |
task-3709518 closes #10675 Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
task-3709518
16.0: Keep Icons section from existing version