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.

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

Add MkDocs documentation #4 #14

Merged
merged 25 commits into from
Feb 2, 2023
Merged

Add MkDocs documentation #4 #14

merged 25 commits into from
Feb 2, 2023

Conversation

Ludee
Copy link
Member

@Ludee Ludee commented Jan 30, 2023 •
edited
Loading

Summary of the discussion

Describe the findings of the discussion in the issue or meeting.

Type of change (CHANGELOG.md)

Added

  • Add the MkDocs documentation (#14)

Workflow checklist

Automation

Part of #4

PR-Assignee

Reviewer

  • 🐙 Follow the Reviewer Guidelines
  • 🐙 Provided feedback and show sufficient appreciation for the work done

jh-RLI and others added 20 commits December 14, 2022 00:57
@jh-RLI
update gitignore
f5083a3
@jh-RLI
add configuration file for mkdocs
1221a33
@jh-RLI
add initial docs content and customization
85bf560
@jh-RLI
update readme:
8f0475c 
- add installation instructions to setup the mkdocs dev environment
@Ludee
Rename and move CSS file #4
e11a852
@Ludee
Rename and move index.md #4
efa3d0d
@Ludee
Rename and move subpage #4
d905ac4
@Ludee
Rename and move second subpage #4
5a6719b
@Ludee
Move and rename OEFamily logo #4
f81d0a3
@Ludee
Move and rename RLI logo #4
f7d8cf9
@Ludee
Rename file #4
62b79b9
@Ludee
Update titles and names #4
300a64b
@Ludee
Move docs folder #4
326877c
@Ludee
Restructure and update documentation #4
0e27ef4
@Ludee
Update documentation #4
9358ca8
@Ludee
Restructure documentation structure #4
be5a6e8
@Ludee
Add basic documentation chapters #4
5cca7b1
@Ludee
Remove alternative readme #4
dff4b6d
@Ludee
Add release section to docs #4
34e2a48
@Ludee
Add page for release #4
77137ff
@Ludee Ludee added part: docu 📖 Improvements or additions to documentation type: enhancement ⚙️ Improvement of an existing feature other: help wanted 🙋 Help or assistance is needed labels Jan 30, 2023
@Ludee Ludee requested a review from jh-RLI January 30, 2023 22:51
@Ludee Ludee self-assigned this Jan 30, 2023
@Ludee Ludee linked an issue Feb 2, 2023 that may be closed by this pull request
Files for field DOCUMENTATION are missing #4
Open
8 tasks
@Ludee Ludee changed the title Add Mkdocs documentation Add Mkdocs documentation #4 Feb 2, 2023
christian-rli
christian-rli approved these changes Feb 2, 2023
View reviewed changes
Copy link

@christian-rli christian-rli left a comment

Choose a reason for hiding this comment

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

lgtm :)

@Ludee Ludee changed the title Add Mkdocs documentation #4 Add MKDocs documentation #4 Feb 2, 2023
@Ludee Ludee changed the title Add MKDocs documentation #4 Add MkDocs documentation #4 Feb 2, 2023
@Ludee Ludee merged commit 4315a5f into develop Feb 2, 2023
@Ludee Ludee deleted the feature-4-mkdocs branch February 2, 2023 21:43
@Ludee Ludee mentioned this pull request Feb 17, 2023
Open
8 tasks
@Ludee Ludee added type: feature 🛠️ New feature or request status: completed ✔️ Task has been completed resolution: released 🎉 Resolved and released and removed type: enhancement ⚙️ Improvement of an existing feature other: help wanted 🙋 Help or assistance is needed labels Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christian-rli christian-rli christian-rli approved these changes

@jh-RLI jh-RLI Awaiting requested review from jh-RLI

Assignees

@Ludee Ludee

Labels
part: docu 📖 Improvements or additions to documentation resolution: released 🎉 Resolved and released status: completed ✔️ Task has been completed type: feature 🛠️ New feature or request
Projects
None yet
Milestone
Complete and document field: DOCUMENT...
Development

Successfully merging this pull request may close these issues.

Files for field DOCUMENTATION are missing
3 participants
@Ludee @christian-rli @jh-RLI