Let's start rewriting Shoes 4 manual.

[ashbb]

I've uploaded the commit porting built-in manual from Purple Shoes.
So, please try out sample99.rb and let us know new issues you found. ;-)

To-do list for now:

• update whole contents (descriptions, snippets and snapshots)
• rewrite Classes List
• run code highlighter
• make html manual

[PragTob]

Cool thanks @ashbb!
We should probably step away from hpricot to nokogiri since hpricot is dead :o

Cheers,
Tobi

[orangethirty]

I can assist with this issue. I do technical documentation projects professionally (just shipped one today), and can use my experience towards helping this project. I'm a software engineer, so I have no problem dealing with all the code, etc.

Please point me towards a good direction to get started. I'm new to the project.

[PragTob]

Weeehhuuu hey @orangethirty thank you for offering your help! :-)
We have a little getting started section in our wiki if you find anything missing there please comment on issue #54 and we will try to update the docs for everyone.

For this specific issue please have a look at the current manual - this is also embedded in normal shoes applications. You would need run the original shoes - which can be tricky, to see the old manual though.

Cheers,
Tobi

[orangethirty]

@PragTob - Thank you. I'm currently going through the sources you provided.
I do have a question. Since this is an original _why project (without taking any credit from the current team who is doing a great job keeping the project going), and he always had this fun way of making documentation, should the documentation be done in his style (again)? Or are you looking for a more straight forward solution?
I'm being serious, btw. :)

[PragTob]

Documentation in a fun way is the way to go - keep the spirit alive. Plus we're all here because we think that Shoes is fun and last but not least one of the major use cases is teaching children how to program :-)

[jrgifford]

Fun documentation is definitely the way to go. Documentation is something that if it is required, it should be a pleasure to read. Too many boring texts out there in the world.

[PragTob]

@jrgifford that's why I wish github hat 👍 buttons :-)

[ashbb]

@ALL Let's go to the next step. ;-)

I'm thinking about the following. What do you think?

There are two ways to make Shoes 4 manual.

1. Update Shoes 3 manual like Green (or Purple) Shoes.
2. Make a new manual.

For the latter, I've an idea.

• Make two manuals.
• One is a normal reference manual quoted necessary parts only from Shoes 3 manual.
• The other is a new guide for beginners to enjoy Shoes 4.

[wasnotrice]

Make two manuals.
One is a normal reference manual quoted necessary parts only from Shoes 3 manual.

How would this be different from updating the Shoes 3 manual like Purple Shoes or Green Shoes?

The other is a new guide for beginners to enjoy Shoes 4.

Great! I like beginner guides :)

[ashbb]

Ah, I'm thinking about it simply.

Delete these pages:

• Hello!
• Introducing
• Installing
• Rules

and delete 'not supported APIs (methods)' descriptions.

[PragTob]

Hello everyone,

the shoes manual is basically ported now isn't it? :-) Request for input.

Cheers,
Tobi

[jrgifford]

unsure of current status, but it appears to be mostly done, yes.

[PragTob]

I'm gonna close it for now, we have an issue open for the broken search :-)