libretro
libretro/docs layout and organization
This issue is for general discussion of the layout and organization (mkdocs.yml) of libretro/docs.
With the recent changes to Getting Started section I think the Windows guide from fr500 is out of place.
I spent some time looking at it but could not decide on a way forward.
I think a little planning may be in order soon before things start getting to messy.
In my opinion a getting started guide should be a single page with a more or less getting started. I dislike the direction the docs have followed, tons of pages without a cadence or context, it's just off.
I'm no longer contributing though, all I can do is express my opinion, the initial documentation effort was all I could do, the rest is up for the community.
I do think you have a point but with the amount of platforms to cover in a single page per platform it may never be complete. The windows guide sat alone for some time.
I would suggest reorganizing the structure somewhat but try to limit the amount of subsections.
I'm currently in your position of not contributing but I'm happy to play with this on my phone when time permits.
Would a Google doc be a better place to plan this out?
On Sat, 28 Apr 2018, 21:26 Andrés, [email protected] wrote:
In my opinion a getting started guide should be a single page with a more or less getting started. I dislike the direction the docs have followed, tons of pages without a cadence or context, it's just off.
I'm no longer contributing though, all I can do is express my opinion, the initial documentation effort was all I could do, the rest is up for the community.
— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/libretro/docs/issues/4#issuecomment-385203215, or mute the thread https://github.com/notifications/unsubscribe-auth/AY_P0M800FyZVwpczba5YFLGVESkRGP2ks5ttNBhgaJpZM4SSA6X .
Made a little attempt to start an easier collaboration effort for menu structure...
I can update this while I dont have docs git setup amd my time at a pc is very limited while I have rls going on. I'm to start my repo agin and make the commits when everything is decided
For edit access see email in document
https://docs.google.com/document/d/1YPaVOzghoyas6jcWus7LPkukpniWX_lHwd732QcpZAc/edit?usp=drivesdk
Also made a poll for Core docs organisation https://strawpoll.com/86b4z58x
Hello folks. With the gracious cooperation of hizzlekizzle I have done some refactoring to the table of contents.
My primary focus was on the "For Developers" section, but some changes have also been made to the "For Users" area -- particularly with regards to a couple of parts of the Core Library.
As far as I know I don't have any other projects in mind, and certainly I would not mind if in the future some even better arrangement is found.
I dig what you have done with the place :)
My only suggestion would be to group Special Cores and Game and Scripting together as I felt they got lost within the emulation tags. C ould help slightly promote the other uses of Libretro/Retroarch as I know that a priority for TA.
On Tue, 19 Mar 2019, 20:27 markwkidd, [email protected] wrote:
Hello folks. With the gracious cooperation of hizzlekizzle I have done some refactoring to the table of contents.
My primary focus was on the "For Developers" section, but some changes have also been made to the "For Users" area -- particularly with regards to a couple of parts of the Core Library.
As far as I know I don't have any other projects in mind, and certainly I would not mind if in the future some even better arrangement is found.
— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/libretro/docs/issues/4#issuecomment-474568952, or mute the thread https://github.com/notifications/unsubscribe-auth/AY_P0A4n4d1XSEnAC2nGKL4o2r5_ds4Oks5vYUhMgaJpZM4SSA6X .
I think that's a good point. I will put together a PR to make the non-emulation cores more prominent next time I'm working
@thatman84 I worked with this concept a bit and I'm pretty happy with the result I've submitted in https://github.com/libretro/docs/pull/298
I think we should expect the core library to continue to grow. This flattens the TOC a little bit, gives it room to grow, and gives the other Core types their fair share of the space.