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: Adding documentation for this library #36

Merged
merged 5 commits into from
Sep 26, 2024
Merged

Conversation

gkrajniak
Copy link
Member

@gkrajniak gkrajniak commented Sep 23, 2024

This change adds the first piece of documentation for end users.
It contains a getting started part describing all the portal module options to consider.
There is also a part added on local development.
Lastly, there is a documentation on the contents of a content configuration file added

@gkrajniak gkrajniak linked an issue Sep 23, 2024 that may be closed by this pull request
@gkrajniak gkrajniak self-assigned this Sep 24, 2024
@gkrajniak gkrajniak changed the title feat: introducing library documentation Introducing library documentation Sep 24, 2024
@vzipf vzipf changed the title Introducing library documentation docs: Adding documentation for this library Sep 25, 2024
Copy link
Contributor

@vzipf vzipf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gkrajniak and @rrogoda thank you very much for this big chunk of work.
I allowed myself to extend some explanations and fix wording here and there.

I think we are mostly done here.
We just need to make sure that we do not refer to any internal knowledge or unpublished material. Otherwise - if this repo will be public - people may be confused

@gkrajniak gkrajniak requested a review from vzipf September 26, 2024 07:11
Copy link
Contributor

@vzipf vzipf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets merge this big chunk of information and work in the detail improvements in follow ups.
Great work, rly!

@vzipf vzipf merged commit 25ea2bd into main Sep 26, 2024
3 checks passed
@vzipf vzipf deleted the feat/lib-documentation branch September 26, 2024 09:08
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.

Document library
2 participants