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

Restructure and refine documentation + add missing tests #1559

Merged
merged 105 commits into from
Nov 22, 2023
Merged

Restructure and refine documentation + add missing tests #1559

merged 105 commits into from
Nov 22, 2023

Conversation

gudmdharalds
Copy link
Contributor

@gudmdharalds gudmdharalds commented Nov 16, 2023 •
edited
Loading

Description

The aim of this pull request is to refine and restructure the documentation for the project.

Pre-deploy checklist

  • Refine files:
    • README.md
    • docs/SETUP.md
      • Add environmental variables
      • Add configuration files
    • docs/ARCHITECTURE.md
    • docs/CONTRIBUTING.md
    • docs/DEBUGGING.md
    • docs/TESTING.md
    • docs/RELEASING.md
    • docs/SECURITY.md
    • docs/CHANGELOG.md
    • Update .github/PULL_REQUEST_TEMPLATE.md
    • Ensure links are correct.
  • Add missing tests:
    • Dependaban check
    • Format:check
  • Merge Updating ESLint config #1577 before this one.
    • Remove CHANGELOG.md from .prettierignore
  • Automated tests pass.

Deploy Notes

None.

Steps to Test

None.

@gudmdharalds gudmdharalds added the [Type] Enhancement New feature or request label Nov 16, 2023
@gudmdharalds gudmdharalds self-assigned this Nov 16, 2023
sjinks
sjinks reviewed Nov 17, 2023
View reviewed changes
docs/SETUP.md Outdated Show resolved Hide resolved
sjinks
sjinks reviewed Nov 17, 2023
View reviewed changes
docs/SETUP.md Outdated Show resolved Hide resolved
sjinks
sjinks reviewed Nov 17, 2023
View reviewed changes
docs/SETUP.md Outdated Show resolved Hide resolved
@gudmdharalds gudmdharalds changed the title Restructure and refine documentation Restructure and refine documentation + add missing tests Nov 20, 2023
@gudmdharalds gudmdharalds mentioned this pull request Nov 21, 2023
Merged
@gudmdharalds gudmdharalds requested a review from sjinks November 21, 2023 11:48
@sonarqubecloud SonarQubeCloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@gudmdharalds gudmdharalds merged commit 252678e into trunk Nov 22, 2023
15 checks passed
@gudmdharalds gudmdharalds deleted the update/restructure-docs-2023 branch November 22, 2023 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sjinks sjinks Awaiting requested review from sjinks

Assignees

@gudmdharalds gudmdharalds

Labels
[Type] Enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gudmdharalds @sjinks