notion-sdk-php icon indicating copy to clipboard operation
notion-sdk-php copied to clipboard

[FEATURE] Add colors and namespaces to documentation

Open utdrmac opened this issue 2 years ago • 2 comments

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

utdrmac avatar Feb 02 '24 18:02 utdrmac

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.

mariosimao avatar Feb 03 '24 00:02 mariosimao

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.

utdrmac avatar Feb 03 '24 02:02 utdrmac