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

Docs: Improve docs for -library instruction (add examples) #6479

Merged
merged 1 commit into from
Feb 24, 2025

Conversation

chrisrueger
Copy link
Contributor

@chrisrueger chrisrueger commented Feb 19, 2025

Here is a suggested for improving the -library instruction. I have heard it being mentioned a couple of times. But I think the current documentation is missing some examples to illustrate the usefulness (as in "what can I do with it, and when would I use it"?)

Here is what I did:

  1. added a introductory sentence
  2. added examples
  3. moved one section "Creating libraries" from the bottom higher up. To me that improves the reading flow and now is basically:
  • What is it
  • examples
  • how to create
  • how to use

Here is a suggested for improving the -library instruction. I have heard it being mentioned a couple of times. But I think the current documentation is missing some examples to illustrate the usefulness (as in "what can I do with it, and when would I use it"?)

Signed-off-by: Christoph Rueger <[email protected]>


Signed-off-by: Christoph Rueger <[email protected]>
@chrisrueger
Copy link
Contributor Author

@pkriens @juergen-albert since you worked on the page and use that feature in the past. Does that make sense what I added?

@pkriens
Copy link
Member

pkriens commented Feb 20, 2025

I'd suggest you just publish this kind of info and then make a short description on the discourse? Others then find out and if there is a discussion this will work to advertise it.

@pkriens
Copy link
Member

pkriens commented Feb 24, 2025

Just merge it ... :-)

@chrisrueger chrisrueger merged commit 4cee6b8 into master Feb 24, 2025
5 checks passed
@chrisrueger chrisrueger deleted the chrisrueger-patch-improve-library-docs branch February 24, 2025 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants