Skip to content

Updates page structure of documentation #16

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 6, 2021
Merged

Updates page structure of documentation #16

merged 2 commits into from
May 6, 2021

Conversation

@froschdesign
Copy link
Member

@froschdesign froschdesign commented May 6, 2021 •
edited
Loading

Q A
Documentation yes
Enhancement yes

For keeping consistency between the different documentations:

  • Extracts introduction to separate page
  • Extracts feature "Parameter Lazy Loading" to separate page
  • Reduces page for basic usage to relevant content

@froschdesign froschdesign changed the title Updates page strcuture of documentation Updates page structure of documentation May 6, 2021
@froschdesign froschdesign added this to the 1.5.1 milestone May 6, 2021
@froschdesign froschdesign mentioned this pull request May 6, 2021
Closed
boesing
boesing approved these changes May 6, 2021
View reviewed changes
Copy link
Member

@boesing boesing left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I guess thats okay?
TBH - this whole documentation stuff is a huge blackbox for me.
If you guys are offering trainings regarding this, I'd be happy to take it 😅

@froschdesign
Copy link
Member Author

froschdesign commented May 6, 2021

@boesing

…this whole documentation stuff is a huge blackbox for me.

My current plan: the contributing guidelines will be added to the website under the headline "Developer Guide". This guide will also contain a documentation writer's guide.

@boesing boesing merged commit 2e07b40 into laminas:1.5.x May 6, 2021
@github-actions github-actions bot mentioned this pull request May 6, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@boesing boesing boesing approved these changes

Assignees

No one assigned

Labels

Documentation Enhancement

Projects

None yet

Milestone

1.5.1

Development

Successfully merging this pull request may close these issues.

2 participants

@froschdesign @boesing