search

mariosimao / notion-sdk-php

A complete Notion SDK for PHP developers.
https://mariosimao.github.io/notion-sdk-php/
MIT License
138 stars 24 forks source link

[FEATURE] Add colors and namespaces to documentation #338

Open utdrmac opened 5 months ago

utdrmac commented 5 months ago

Is your feature request related to a problem? Please describe. I'm frustrated that the examples in the documentation do not show which use namespaces are needed. I have to keep looking in the code to figure this out. Additionally, richtext supports specific notion colors, but these are not in the documentation.

Ex: https://mario.engineering/notion-sdk-php/blocks/Paragraph.html

Describe the solution you'd like I'd like to see the documentation code examples updated with Notion\Path\Example style usage, or use at the top. Additionally, on the RichText/Paragraph page, all supported colors, and supported text styles should be documented. (strikethrough is not shown, but it is in the code)

Describe alternatives you've considered Keep having to dig through the code

mariosimao commented 5 months ago

Hello @utdrmac, thank you for submitting this issue.

I've removed the namespaces to simplify the documentation.

Unfortunately, I do not have enough time to make the documentation 100% complete. What editor/IDE are you using? The library has 100% type coverage and should straight forward to use it with autocompletion.

IDEs can also automatically include the namespace.

utdrmac commented 5 months ago

I'm not using a formal IDE. I just use a text editor, BBEdit, so I rely 100% on documentation when trying to use new libraries.