Harmonize keywords / tags used in various informational entries about Rubix ML

RubixML / ML

A high-level machine learning and deep learning library for the PHP language.

https://rubixml.com

MIT License

2.03k stars 182 forks source link

Harmonize keywords / tags used in various informational entries about Rubix ML #78

Open marclaporte opened 4 years ago

marclaporte commented 4 years ago

Rubix ML has a huge number of features. Each feature can be a way for users to discover us. And once they do, discover all the richness.

Keywords on Github, and the following sources are inconsistent: https://www.openhub.net/p/RubixML https://packagist.org/packages/rubix/

I will make a more complete list of keywords, to be used everywhere. This will likely be a new page in the docs, so we can put relevant hyperlinks, and we can improve collaboratively from then on.

This issue is just a reminder for me to do so. If you have ideas on the topic, please share.

andrewdalpino commented 4 years ago

I like this idea. We haven't done a full keyword inventory yet ever. What did you have in mind for the new doc page?

marclaporte commented 4 years ago

Here is something similar: https://doc.tiki.org/Keywords but I think we can do better.

End result: A few sections of alphabetical lists of all keywords / acronyms / concepts and with links to relevant documentation, code or feature requests. This will be very good for SEO. For people that are new to ML: it permits to discover concepts (with hyperlinks). For experienced people, it helps position Rubix vs what they know. Even keywords for which we have no code/intention: it should explain why we don't do and perhaps link to alternatives.

The ones we want to reuse on Open Hub / Packagist / Github are identified somehow. Ex.: in bold or a color.

Proposed plan:

Start on a Github wiki page
Add all possible keywords alphabetically
See what categories emerge (ex.: I get the impression that algorithms warrant a section)
Cluster
Clean up
Move to docs and delete wiki page (future tweaks done via merge requests)

andrewdalpino commented 4 years ago

Kinda like a glossary except instead of a brief summary of the topic we provide a link to the content?

marclaporte commented 4 years ago

yup :-)

andrewdalpino commented 4 years ago

We have something like that here ...

https://github.com/RubixML/RubixML/blob/master/mkdocs.yml

Do we need something more for discovery and SEO purposes?

marclaporte commented 4 years ago

That is a superb list! I love it. Let's build on it.

2 things to add:

This content (no need to change structure) in a page listing with its own URL (not just the menu on https://docs.rubixml.com/)
New pages for things that people will look for but we do a different way, like MoreLikeThis

Thanks!