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

Add short overview to docs? #5

Open
cormullion opened this issue Mar 28, 2024 · 1 comment
Open

Add short overview to docs? #5

cormullion opened this issue Mar 28, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@cormullion
Copy link

Cool package- and good documentation!
A possible enhancement would be to add a short overview as to what and why. Something like this:

https://discourse.julialang.org/t/indexing-unicode-strings/62325/11

which appeared after some searching.

I wondered if a diagram might be useful too?

@mnemnion
Copy link
Owner

Adding some rationale and at least some links to the important concepts is a good idea, I'll work on that.

I think I get what you mean by diagrams, I'm not getting a good mental picture of what they'd look like yet. There are a couple diagramming packages for Documenter which I might be able to use there, I'd want the diagrams to be text-based rather than created directly in a vector package, for a few reasons, accessibility being one. A few more examples showing how strings break down into codepoints, chars, graphemes etc. might be enough there.

@mnemnion mnemnion added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 28, 2024
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants