Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Add colors and namespaces to documentation #338

Open
utdrmac opened this issue Feb 2, 2024 · 2 comments
Open

[FEATURE] Add colors and namespaces to documentation #338

utdrmac opened this issue Feb 2, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@utdrmac
Copy link

utdrmac commented Feb 2, 2024

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 utdrmac added the enhancement New feature or request label Feb 2, 2024
@mariosimao
Copy link
Owner

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 mariosimao self-assigned this Feb 3, 2024
@mariosimao mariosimao added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Feb 3, 2024
@utdrmac
Copy link
Author

utdrmac commented Feb 3, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants