search

pure-data / pddp

Pure Data Documentation Project
7 stars 2 forks source link

reorganize manual files in the docs #212

Closed porres closed 1 month ago

porres commented 1 month ago

Hi, I feel the manual folder is still quite polluted. We do have a folder for pics now, which improved things, but we still have things to improve. We could simply have 'index' and everything else into a resourced folder. I never liked how chapters are there and as 'x1', 'x2', etc... it's not meaninful and maybe just index should be enough! So I guess chapters could also be in a separata folder with the other stuff. Also, I don't see the need of '1.introduction.txt'.

So, something like this

Screen Shot 2024-05-20 at 15 30 41

what do you think @ben-wes ?

porres commented 1 month ago

I wonder why the icon is in css and if we can't just have this files outside this folder (and adding an icon to the manual header in index would be nice too by the way). So, something like this?

Screen Shot 2024-05-20 at 15 37 54

porres commented 1 month ago

Also, I don't see the need of '1.introduction.txt'.

Ok, this is the 'about Pd' file. It should be inside the manual, it could be renamed as such and put elsewhere

porres commented 1 month ago

I renamed to About.Pd.txt in my local-doc branch and rellocated it, and now I also think this file shouldn't be copied to Pd's doc folder one way or another

porres commented 1 month ago

ok, favicon.ico is the icon that shows up in your browser's tab, right?

porres commented 1 month ago

So, been doing it and I think it looks much better, this now makes people just look into 'index' hopefully

Screen Shot 2024-05-20 at 22 58 30

porres commented 1 month ago

rebooting

ben-wes commented 1 month ago

ok, favicon.ico is the icon that shows up in your browser's tab, right?

yes. and this .ico file includes 3 resolutions of the logo for the browser to choose from: 16x16, 32x32, 48x48.

what do you think @ben-wes ?

in general, i'm fine with a different structure. i'm not completely sure if i would consider the other html files "resources" though - but that's a minor semantic question, i guess.

it would be nice if the manual's content shows up for users searching online at some point (https://msp.ucsd.edu/Pd_documentation/x2.htm already does appear in the first results now when googling autopatching puredata for example). moving files is a bit like a reset. but it will get there again. besides that, i have no idea if we're destroying a relevant amount of links from other sources. but with the other changes already in place, they will most likely not point to the same results anymore anyway (e.g. other paragraph ids).