Create standalone doc website

[alexreardon]

The main purpose of this is to split up our large readme.md files into more manageable chunks.

Core deliverables:

• split up our large readme file into small chunks that can be easily navigated to
• all documentation files are able to be written as plane .md files
• ideally we want to have as little custom code as possible to drive the site

Ideals

• mobile friendly (the library is - so our docs should be too!)
• have examples integrated within the site. Ideally we can drop our storybooks

[alexreardon]

/cc @Noviny will be leading this one

[alexreardon]

Related to #163

[basitsattar]

Any update?

[Noviny]

Working on this right now. Hoping to have it up by the end of the week.

[Noviny]

PR for this is now at #394

Work isn't done yet, but framework is in place. Next priority is just make sure any shifting of code is done (mostly moving examples to the website examples folder) so this can be merged.

[alexreardon]

Soon

Related: #363

[joshuagautham]

@alexreardon - Any tentative date of release? Want to use this piece.

[alexreardon]

Getting closer...

[alexreardon]

Trello board to track this one: https://trello.com/b/McyW8upT/react-beautiful-dnd-website

[ng-hai]

Hi @alexreardon, I had used react-beautiful-dnd to implement an app like Trello, which was featured on appendto.com as an inspiration project. Could I make a PR to submit my project to the docs?

[alexreardon]

Sounds great! Could you make a PR to add a link to our community section?

…

On Tue, 30 Oct 2018 at 3:27 am, Hai Nguyen ***@***.***> wrote: Hi @alexreardon <https://github.com/alexreardon>, I had used react-beautiful-dnd to implement an app like Trello <http://simple-trello.netlify.com>, which was featured on appendto.com <https://appendto.com/2018/08/25-public-react-repos-apps-to-inspire-your-next-project-part-1-2/> as an inspiration project. Could I make a PR to submit my project to the docs? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#343 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACFN7XqqnHGW0mEH4ZlFyPkO7JTuIy90ks5upyxrgaJpZM4SQaHr> .

[dgdosen]

The docs aren't very discoverable. Sure there are titles... But they're not really organized for a new user...

[alexreardon]

@dgdosen for now we have decided to focus on some critical features and park the website build.

Assuming we are only using github for now, how do you think we could better organise our existing content?

[dgdosen]

I'll revise my comment after finding the API section in the readme... IMO - it's buried way down there. Most components lead with API information! It's much more important than say, drop animations, etc..

[alexreardon]

Perhaps we could look at:

• restructuring the content
• breaking the big README.md into seperate markdown files
• adding a small table of contents to the start of the README.md

Do you think these would be helpful @dgdosen ?

[alexreardon]

I am also keen to get your thoughts @Noviny

[Noviny]

If we could get a nice clear information structure that breaks down the existing docs, it should be very easy to build a quick website on top of it. If you can break them up, and link them together assuming github, I can sort out the other bit.

[alexreardon]

@dgdosen I have done some major documentation refactoring. You can read about it here: 10.1 release notes

How do you feel about them now?

[alexreardon]

I will close this issue for now. I think we are getting further than I expected with simply using markdown files

[alexreardon]

I am keen to add a stand alone site though!