search

orcnog / orcnog-card-viewer

MIT License
4 stars 0 forks source link

Request for Documentation on Macros and API Usage #5

Closed brunocalado closed 1 year ago

brunocalado commented 1 year ago

Issue Description: Firstly, I must say that your module is absolutely incredible! However, I would like to kindly request the addition of documentation specifically focused on the usage of macros and the API.

Request: I kindly request that you consider adding comprehensive documentation that covers the usage and implementation of macros and the API within your module. Such documentation would greatly benefit users like myself who are eager to explore and utilize the full potential of these features.

Keep up the great work!

orcnog commented 1 year ago

@brunocalado Thank you!

Can do - detailed documentation is on my to-do list anyway, along with a quick GIF video demo showcasing how to use this module.

I've never actually added formal, generated API documentation before. Any suggestions? If not, I will go ahead and just wing it with some manual descriptions and examples.

brunocalado commented 1 year ago

I'll do it.

brunocalado commented 1 year ago

docs card.txt

brunocalado commented 1 year ago

video demo: https://github.com/orcnog/orcnog-card-viewer/assets/4999783/ad6dcc8a-5da0-4c7c-915c-931b1d5b8006

orcnog commented 1 year ago

You're awesome. Thank you for this. I'm adding to it and will push it live soon.

orcnog commented 1 year ago

Added.

brunocalado commented 1 year ago

You could this video too: https://github.com/orcnog/orcnog-card-viewer/assets/4999783/ad6dcc8a-5da0-4c7c-915c-931b1d5b8006