You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@wayang.apache.org by Bertty Contreras <be...@scalytics.io> on 2021/04/17 19:08:11 UTC

Documentation Style and Structure

Hi Folks,

I just finished the documentation page style and the structure of the
documentation, however, is missing the content.

 I want to ask you if you like the style and the structure or if you think
that something is missing or wrong ?

The documentation could be found on https://wayang.apache.org/docs/latest/

Best regards,
Bertty

Re: Documentation Style and Structure

Posted by jorge Arnulfo Quiané Ruiz <qu...@apache.org>.
Hello all,

Overall I like it too! Well done guys!!!
I would just propose the following remaining change: reduce the height of
the next and previous buttons (they are way too big for my taste) :p

Other than that, we just need to start populating the documentation :)

Best,
Jorge

On Tue, Apr 20, 2021 at 12:35 AM jorge Arnulfo Quiané Ruiz <
quianeufo@gmail.com> wrote:

> Hello all,
>
> Overall I like it too! Well done guys!!!
> I would just propose the following remaining change: reduce the height of
> the next and previous buttons (they are way too big for my taste) :p
>
> Other than that, we just need to start populating the documentation :)
>
> Best,
> Jorge
>
> On Tue, Apr 20, 2021 at 12:10 AM Bertty Contreras <be...@scalytics.io>
> wrote:
>
>> Hi Folks,
>>
>> I did the changes propose from zoi and they looks so nice, please take a
>> look :D
>>
>> Best,
>> Bertty
>>
>> On Sun, Apr 18, 2021 at 12:08 PM Bertty Contreras <be...@scalytics.io>
>> wrote:
>>
>> > The Readme page is just to see how it will look when the documentation
>> is
>> > compiled, it will remove it.
>> >
>> > I will do the modification on the menu and I will see the size of the
>> > buttons.
>> >
>> > Best regards,
>> > Bertty
>> >
>> >
>> >
>> > On Sun, Apr 18, 2021 at 11:54 AM Zoi Kaoudi <zk...@yahoo.gr.invalid>
>> > wrote:
>> >
>> >>  Hi Bertty,
>> >> It looks very nice!
>> >>
>> >> I have a few comments for improvement:
>> >> - Remove the article: "Turning a shadows into a show" --> "Turning
>> >> shadows into a show"
>> >>
>> >> - I would avoid the capitalization of the text on the second level menu
>> >> items keep capital only the first letter. eg: "HOW TO BUILD WAYANG" -->
>> >> "How to build Wayang"
>> >> - When I click in an item in the menu and there is another item which
>> is
>> >> clickable but it's a subcategory it looks very similar with the main
>> menu
>> >> and looks confusing imo. Maybe using smaller fonts and/or avoid the
>> >> capitalization or use the purple color for the second level items would
>> >> solve this. eg: "Getting started with Wayang" and "How to build Wayang"
>> >> should look a bit different. Either other color or different fonts.
>> >> - "Writing a plan with Wayang" --> "Writing a Wayang plan"
>> >>
>> >> - The buttons Next and Previous look very big now. I would make them
>> >> smaller.
>> >> Other than these minor, it looks very cool.
>> >>
>> >> Best
>> >> --
>> >> Zoi
>> >>
>> >>     Στις Σάββατο, 17 Απριλίου 2021, 9:08:35 μ.μ. CEST, ο χρήστης Bertty
>> >> Contreras <be...@scalytics.io> έγραψε:
>> >>
>> >>  Hi Folks,
>> >>
>> >> I just finished the documentation page style and the structure of the
>> >> documentation, however, is missing the content.
>> >>
>> >>  I want to ask you if you like the style and the structure or if you
>> think
>> >> that something is missing or wrong ?
>> >>
>> >> The documentation could be found on
>> >> https://wayang.apache.org/docs/latest/
>> >>
>> >> Best regards,
>> >> Bertty
>> >>
>> >
>> >
>>
>

Re: Documentation Style and Structure

Posted by Bertty Contreras <be...@scalytics.io>.
Then we will start the population :D

On Mon, Apr 19, 2021 at 6:35 PM jorge Arnulfo Quiané Ruiz <
quianeufo@gmail.com> wrote:

> Hello all,
>
> Overall I like it too! Well done guys!!!
> I would just propose the following remaining change: reduce the height of
> the next and previous buttons (they are way too big for my taste) :p
>
> Other than that, we just need to start populating the documentation :)
>
> Best,
> Jorge
>
> On Tue, Apr 20, 2021 at 12:10 AM Bertty Contreras <be...@scalytics.io>
> wrote:
>
> > Hi Folks,
> >
> > I did the changes propose from zoi and they looks so nice, please take a
> > look :D
> >
> > Best,
> > Bertty
> >
> > On Sun, Apr 18, 2021 at 12:08 PM Bertty Contreras <be...@scalytics.io>
> > wrote:
> >
> > > The Readme page is just to see how it will look when the documentation
> is
> > > compiled, it will remove it.
> > >
> > > I will do the modification on the menu and I will see the size of the
> > > buttons.
> > >
> > > Best regards,
> > > Bertty
> > >
> > >
> > >
> > > On Sun, Apr 18, 2021 at 11:54 AM Zoi Kaoudi <zk...@yahoo.gr.invalid>
> > > wrote:
> > >
> > >>  Hi Bertty,
> > >> It looks very nice!
> > >>
> > >> I have a few comments for improvement:
> > >> - Remove the article: "Turning a shadows into a show" --> "Turning
> > >> shadows into a show"
> > >>
> > >> - I would avoid the capitalization of the text on the second level
> menu
> > >> items keep capital only the first letter. eg: "HOW TO BUILD WAYANG"
> -->
> > >> "How to build Wayang"
> > >> - When I click in an item in the menu and there is another item which
> is
> > >> clickable but it's a subcategory it looks very similar with the main
> > menu
> > >> and looks confusing imo. Maybe using smaller fonts and/or avoid the
> > >> capitalization or use the purple color for the second level items
> would
> > >> solve this. eg: "Getting started with Wayang" and "How to build
> Wayang"
> > >> should look a bit different. Either other color or different fonts.
> > >> - "Writing a plan with Wayang" --> "Writing a Wayang plan"
> > >>
> > >> - The buttons Next and Previous look very big now. I would make them
> > >> smaller.
> > >> Other than these minor, it looks very cool.
> > >>
> > >> Best
> > >> --
> > >> Zoi
> > >>
> > >>     Στις Σάββατο, 17 Απριλίου 2021, 9:08:35 μ.μ. CEST, ο χρήστης
> Bertty
> > >> Contreras <be...@scalytics.io> έγραψε:
> > >>
> > >>  Hi Folks,
> > >>
> > >> I just finished the documentation page style and the structure of the
> > >> documentation, however, is missing the content.
> > >>
> > >>  I want to ask you if you like the style and the structure or if you
> > think
> > >> that something is missing or wrong ?
> > >>
> > >> The documentation could be found on
> > >> https://wayang.apache.org/docs/latest/
> > >>
> > >> Best regards,
> > >> Bertty
> > >>
> > >
> > >
> >
>

Re: Documentation Style and Structure

Posted by jorge Arnulfo Quiané Ruiz <qu...@gmail.com>.
Hello all,

Overall I like it too! Well done guys!!!
I would just propose the following remaining change: reduce the height of
the next and previous buttons (they are way too big for my taste) :p

Other than that, we just need to start populating the documentation :)

Best,
Jorge

On Tue, Apr 20, 2021 at 12:10 AM Bertty Contreras <be...@scalytics.io>
wrote:

> Hi Folks,
>
> I did the changes propose from zoi and they looks so nice, please take a
> look :D
>
> Best,
> Bertty
>
> On Sun, Apr 18, 2021 at 12:08 PM Bertty Contreras <be...@scalytics.io>
> wrote:
>
> > The Readme page is just to see how it will look when the documentation is
> > compiled, it will remove it.
> >
> > I will do the modification on the menu and I will see the size of the
> > buttons.
> >
> > Best regards,
> > Bertty
> >
> >
> >
> > On Sun, Apr 18, 2021 at 11:54 AM Zoi Kaoudi <zk...@yahoo.gr.invalid>
> > wrote:
> >
> >>  Hi Bertty,
> >> It looks very nice!
> >>
> >> I have a few comments for improvement:
> >> - Remove the article: "Turning a shadows into a show" --> "Turning
> >> shadows into a show"
> >>
> >> - I would avoid the capitalization of the text on the second level menu
> >> items keep capital only the first letter. eg: "HOW TO BUILD WAYANG" -->
> >> "How to build Wayang"
> >> - When I click in an item in the menu and there is another item which is
> >> clickable but it's a subcategory it looks very similar with the main
> menu
> >> and looks confusing imo. Maybe using smaller fonts and/or avoid the
> >> capitalization or use the purple color for the second level items would
> >> solve this. eg: "Getting started with Wayang" and "How to build Wayang"
> >> should look a bit different. Either other color or different fonts.
> >> - "Writing a plan with Wayang" --> "Writing a Wayang plan"
> >>
> >> - The buttons Next and Previous look very big now. I would make them
> >> smaller.
> >> Other than these minor, it looks very cool.
> >>
> >> Best
> >> --
> >> Zoi
> >>
> >>     Στις Σάββατο, 17 Απριλίου 2021, 9:08:35 μ.μ. CEST, ο χρήστης Bertty
> >> Contreras <be...@scalytics.io> έγραψε:
> >>
> >>  Hi Folks,
> >>
> >> I just finished the documentation page style and the structure of the
> >> documentation, however, is missing the content.
> >>
> >>  I want to ask you if you like the style and the structure or if you
> think
> >> that something is missing or wrong ?
> >>
> >> The documentation could be found on
> >> https://wayang.apache.org/docs/latest/
> >>
> >> Best regards,
> >> Bertty
> >>
> >
> >
>

Re: Documentation Style and Structure

Posted by Bertty Contreras <be...@scalytics.io>.
Hi Folks,

I did the changes propose from zoi and they looks so nice, please take a
look :D

Best,
Bertty

On Sun, Apr 18, 2021 at 12:08 PM Bertty Contreras <be...@scalytics.io>
wrote:

> The Readme page is just to see how it will look when the documentation is
> compiled, it will remove it.
>
> I will do the modification on the menu and I will see the size of the
> buttons.
>
> Best regards,
> Bertty
>
>
>
> On Sun, Apr 18, 2021 at 11:54 AM Zoi Kaoudi <zk...@yahoo.gr.invalid>
> wrote:
>
>>  Hi Bertty,
>> It looks very nice!
>>
>> I have a few comments for improvement:
>> - Remove the article: "Turning a shadows into a show" --> "Turning
>> shadows into a show"
>>
>> - I would avoid the capitalization of the text on the second level menu
>> items keep capital only the first letter. eg: "HOW TO BUILD WAYANG" -->
>> "How to build Wayang"
>> - When I click in an item in the menu and there is another item which is
>> clickable but it's a subcategory it looks very similar with the main menu
>> and looks confusing imo. Maybe using smaller fonts and/or avoid the
>> capitalization or use the purple color for the second level items would
>> solve this. eg: "Getting started with Wayang" and "How to build Wayang"
>> should look a bit different. Either other color or different fonts.
>> - "Writing a plan with Wayang" --> "Writing a Wayang plan"
>>
>> - The buttons Next and Previous look very big now. I would make them
>> smaller.
>> Other than these minor, it looks very cool.
>>
>> Best
>> --
>> Zoi
>>
>>     Στις Σάββατο, 17 Απριλίου 2021, 9:08:35 μ.μ. CEST, ο χρήστης Bertty
>> Contreras <be...@scalytics.io> έγραψε:
>>
>>  Hi Folks,
>>
>> I just finished the documentation page style and the structure of the
>> documentation, however, is missing the content.
>>
>>  I want to ask you if you like the style and the structure or if you think
>> that something is missing or wrong ?
>>
>> The documentation could be found on
>> https://wayang.apache.org/docs/latest/
>>
>> Best regards,
>> Bertty
>>
>
>

Re: Documentation Style and Structure

Posted by Bertty Contreras <be...@scalytics.io>.
The Readme page is just to see how it will look when the documentation is
compiled, it will remove it.

I will do the modification on the menu and I will see the size of the
buttons.

Best regards,
Bertty



On Sun, Apr 18, 2021 at 11:54 AM Zoi Kaoudi <zk...@yahoo.gr.invalid>
wrote:

>  Hi Bertty,
> It looks very nice!
>
> I have a few comments for improvement:
> - Remove the article: "Turning a shadows into a show" --> "Turning shadows
> into a show"
>
> - I would avoid the capitalization of the text on the second level menu
> items keep capital only the first letter. eg: "HOW TO BUILD WAYANG" -->
> "How to build Wayang"
> - When I click in an item in the menu and there is another item which is
> clickable but it's a subcategory it looks very similar with the main menu
> and looks confusing imo. Maybe using smaller fonts and/or avoid the
> capitalization or use the purple color for the second level items would
> solve this. eg: "Getting started with Wayang" and "How to build Wayang"
> should look a bit different. Either other color or different fonts.
> - "Writing a plan with Wayang" --> "Writing a Wayang plan"
>
> - The buttons Next and Previous look very big now. I would make them
> smaller.
> Other than these minor, it looks very cool.
>
> Best
> --
> Zoi
>
>     Στις Σάββατο, 17 Απριλίου 2021, 9:08:35 μ.μ. CEST, ο χρήστης Bertty
> Contreras <be...@scalytics.io> έγραψε:
>
>  Hi Folks,
>
> I just finished the documentation page style and the structure of the
> documentation, however, is missing the content.
>
>  I want to ask you if you like the style and the structure or if you think
> that something is missing or wrong ?
>
> The documentation could be found on https://wayang.apache.org/docs/latest/
>
> Best regards,
> Bertty
>

Re: Documentation Style and Structure

Posted by Zoi Kaoudi <zk...@yahoo.gr.INVALID>.
 Hi Bertty,
It looks very nice! 

I have a few comments for improvement:
- Remove the article: "Turning a shadows into a show" --> "Turning shadows into a show" 

- I would avoid the capitalization of the text on the second level menu items keep capital only the first letter. eg: "HOW TO BUILD WAYANG" --> "How to build Wayang"
- When I click in an item in the menu and there is another item which is clickable but it's a subcategory it looks very similar with the main menu and looks confusing imo. Maybe using smaller fonts and/or avoid the capitalization or use the purple color for the second level items would solve this. eg: "Getting started with Wayang" and "How to build Wayang" should look a bit different. Either other color or different fonts.
- "Writing a plan with Wayang" --> "Writing a Wayang plan"

- The buttons Next and Previous look very big now. I would make them smaller.
Other than these minor, it looks very cool.

Best
--
Zoi

    Στις Σάββατο, 17 Απριλίου 2021, 9:08:35 μ.μ. CEST, ο χρήστης Bertty Contreras <be...@scalytics.io> έγραψε:  
 
 Hi Folks,

I just finished the documentation page style and the structure of the
documentation, however, is missing the content.

 I want to ask you if you like the style and the structure or if you think
that something is missing or wrong ?

The documentation could be found on https://wayang.apache.org/docs/latest/

Best regards,
Bertty
  

Re: Documentation Style and Structure

Posted by Rodrigo Pardo Meza <ro...@gmail.com>.
Looking nice,

+1

Best regards!

El sáb, 17 abr 2021 a las 17:43, Alexander Alten-Lorenz (<al...@scalytics.io>)
escribió:

> Hey Bertty,
>
> Thank you - like it :)
> +1
>
> Best,
> —Alex
>
> Sent from my iPhone
>
> > On 17. Apr 2021, at 21:08, Bertty Contreras <be...@scalytics.io> wrote:
> >
> > Hi Folks,
> >
> > I just finished the documentation page style and the structure of the
> > documentation, however, is missing the content.
> >
> > I want to ask you if you like the style and the structure or if you think
> > that something is missing or wrong ?
> >
> > The documentation could be found on
> https://wayang.apache.org/docs/latest/
> >
> > Best regards,
> > Bertty
>

Re: Documentation Style and Structure

Posted by Alexander Alten-Lorenz <al...@scalytics.io>.
Hey Bertty,

Thank you - like it :)
+1 

Best,
—Alex 

Sent from my iPhone

> On 17. Apr 2021, at 21:08, Bertty Contreras <be...@scalytics.io> wrote:
> 
> Hi Folks,
> 
> I just finished the documentation page style and the structure of the
> documentation, however, is missing the content.
> 
> I want to ask you if you like the style and the structure or if you think
> that something is missing or wrong ?
> 
> The documentation could be found on https://wayang.apache.org/docs/latest/
> 
> Best regards,
> Bertty