Add Design Patterns in Developer guides #76
Conversation
|
nice! I see that both a .rst and .md are commited, is that correct? I think they are the same and only the .rst is used, right? |
Yeah, only the .rst is used to display the page and I have used sphinx to extract contents from the .md whenever applicable. I haven't modified the contents however, I copied it as it is from the markdown so maybe that needs to be looked at. |
colinkiama
left a comment
colinkiama
left a comment
There was a problem hiding this comment.
Hi, thanks for the pull request!
Unfortunately, this doesn't follow a similar style and structure like the other guides and tutorials in the documentation.
Because the design patterns markdown file is so huge, I suggest using pandoc to convert the file from Markdown (.MD) to reStructuredText (.rst).
I'm happy with the result of that being added.
Optionally: It would be really cool if you could split the guide into multiple pages too. Much better than reading one enormous page 😅.
Good luck!
|
splitting the guide is not that hard. I wrote a simple python script once, that parses the subheadings, and moves them into its own file. |
Do you have it on github? If you could share it that would be really helpful. |
|
sadly not, was a one-time-throw away thing I guess 🥲 |
|
@colinkiama the design patterns are grouped in 3 categories, each one having multiple examples. We could either keep them into 3 pages, each page having all design patterns of a particular category. But we could also have one design pattern per page (which would require >25 pages), so I need your opinion on how to split it, on the basis of categories (creational/structural/behavioral), or one page for every example? |
|
I think that 3 pages is fine. We could explore how we could organise this better in another merge request in the future. |
sudhanshuv1
force-pushed
the
design-patterns
branch
from
4e1386f to
14c7b44
Compare
|
@sudhanshuv1 is this merge request ready now? |
colinkiama
left a comment
colinkiama
left a comment
There was a problem hiding this comment.
Never mind, there is one more change left to do
|
|
||
|
|
||
| .. figure:: | ||
| https://cloud.githubusercontent.com/assets/11269635/23065273/1b7e5938-f515-11e6-8dd3-d0d58de6bb9a.png |
There was a problem hiding this comment.
The image needs to be in the website. A relative link to the website
There was a problem hiding this comment.
Please look at how images are added in Vala Compiler Guide - Vala In a Nutshell:
These images need to be stored in the site.
There was a problem hiding this comment.
Fixed it, sorry for the delay.
colinkiama
left a comment
colinkiama
left a comment
There was a problem hiding this comment.
Great! Thank you for your contribution!
3 participants
Adds the guide to design patterns in Developer guides, (using https://github.com/design-patterns-for-humans/vala)
Fixes #63 .