search

datamol-io / molfeat

molfeat - the hub for all your molecular featurizers
https://molfeat.datamol.io
Apache License 2.0
169 stars 16 forks source link

Design / Concept doc as a separate page. #71

Closed maclandrol closed 4 months ago

maclandrol commented 11 months ago

I found the FAQ to be excellent.

Given how much information is given in the FAQ, maybe it would be worth having a dedicated section (or more than one) on the usage.md page or another one covering the basics design concepts of molfeat? Those would be based on the various questions in the FAQ (and probably make the FAQ shorter).

It's just a proposal since I found the FAQ to already be super informative without more changes.

Originally posted by @hadim in https://github.com/datamol-io/molfeat/pull/70#pullrequestreview-1545251164

cwognum commented 11 months ago

I really like the FAQ too!

Another idea could be to use collapsible admonitions to make the information easier to parse. There already is a question type admonition, but we could also customize this or add our own if we dislike the colors / icon.

maclandrol commented 11 months ago

I used them at the start, but table inside are not well parsed. So I went back to the current version.