cables-gl / cables_docs

cables documentation docs.cables.gl
https://cables.gl/docs/docs
45 stars 16 forks source link

Streamline docs in export #871

Open TobyKLight opened 1 month ago

TobyKLight commented 1 month ago

Feature Request

This one is pretty minor but thought I would write it up

Problem

Currently in the export you get all these docs in the root folder -cables.txt -credits.txt -legal.txt -LICENCE (text of the MIT licence) -doc.md (from the filename looks like it's human readable but just seems to be a list of variables? Is it needed for standard export usecase?)

The only real problem with this is that even if you export an 'all rights reserved' patch it still has this LICENCE file in the root folder. So it looks like this is the licence of the patch you exported, not just the licence of the cables components.

Proposal

-Put cables.txt, credits.txt, legal.txt and LICENCE together in one document cablesCreditsLegal.txt -Remove doc.md from the standard export unless it's needed? -In the end most end users will not know there are documentation files sitting next to html files. For better attribution of cables.gl and credits/licences of components in final apps then perhaps could implement this feature to get the credits text in an op? https://github.com/cables-gl/cables_docs/issues/868 And then could also have a sidebar credits button that shows official reccomended way to attribute?

This changed docs feature could be a tickbox option for export if there's some reason to leave it like this....