Closed braun-steven closed 1 year ago
I think this is a great idea, thank you for taking the initiative!
I am wondering whether the proposed implementation is the best solution, though, because it makes the addition of future styles more complex: whenever a new set of styles is implemented, say for TMLR, it would have to be added manually to both files. I would suppose such lists might get outdated quickly.
So instead, how about we have a loose bullet point list of supported venues (without years, just the name of the venue) in the README and add a link to the API docs somewhere close to the list? This way, it would be easy to see which kind of venue is supported, but we would not add overhead to future contributions.
What do you think?
Totally agree with you, I've updated the PR with your suggestion: a simple list of supported venues and a link to the API for further details.
I guess that's up to you: where do you want new users to land first? The readthedocs site or rather the GitHub repo? If you were to share a single link to your project now, which one would it be? :-)
Good point. Let's go for the index. Thanks for following up!
Done, feel free to squash merge to get rid of all the intermediate commits.
First time users might be interested in a quick overview of whether their targeted venue is supported by tueplots. While this information can be found in the API docs, I think it would be good to provide an overview on the "landing page" of this package, i.e., either the GitHub README file or the docs index file.