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: Frontend README separation to /docs #367

Merged
merged 4 commits into from
Nov 14, 2024
Merged

Conversation

peteski22
Copy link
Contributor

@peteski22 peteski22 commented Nov 14, 2024

What's changing

To align with our new docs structure, the frontend README has been split up a little, with 'getting started' information moved to an operations guide.

How to test it

Additional notes for reviewers

#357 (comment)

I already...

  • added some tests for any new functionality
  • updated the documentation
  • checked if a (backend) DB migration step was required and included it if required

@peteski22 peteski22 added the documentation Improvements or additions to documentation label Nov 14, 2024
@peteski22 peteski22 changed the title Separate README for frontend - some becomes an operations guide Docs: Frontend README separation to /docs Nov 14, 2024
@dpoulopoulos
Copy link
Contributor

@peteski22 the content is great. Can you please move the guide under operations-guide instead of get-started? This is a guide for how to set up a dev environment, not to get started with Lumigator, right?

@peteski22
Copy link
Contributor Author

@peteski22 the content is great. Can you please move the guide under operations-guide instead of get-started? This is a guide for how to set up a dev environment, not to get started with Lumigator, right?

@dpoulopoulos I've appended it to docs/source/operations-guide/dev.md 😄

@peteski22 peteski22 merged commit 39d3d67 into main Nov 14, 2024
6 checks passed
@peteski22 peteski22 deleted the docs/frontend-separation branch November 14, 2024 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants