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 Project Documentation #141

Merged
merged 67 commits into from
Jun 22, 2024
Merged

Add Mkdocs Project Documentation #141

merged 67 commits into from
Jun 22, 2024

Conversation

AntonioMrtz
Copy link
Owner

Description

Build infrastructure for mkdocs and write the associated documentation for the project.

Commit type

Docs

Issue

Solution

Proposed Changes

  • Build infrastructure for mkdocs
  • Write documentation
  • Update existing documentation

Potential Impact

Tests Performed

  • [✅] Test performed

Screenshots

Additional Tasks

Assigned

@AntonioMrtz

AntonioMrtz and others added 30 commits May 24, 2024 09:35
@AntonioMrtz
docs: add ENVIROMENTS
58d3451
@AntonioMrtz
docs: add mkdocs structure with enviroment and git convention files
5e7378c
@AntonioMrtz
ci: add generate docs pipeline
dd0dc3d
@AntonioMrtz
ci: fix requirement install generate docs workflow
8db7780
@AntonioMrtz
docs: publish docs into gh-pages
5a0cf19
@AntonioMrtz
docs: add nested bullet lists to mkdocsp
b3448ed
@AntonioMrtz
docs: add nested bullet lists to mkdocs
b520e81
@AntonioMrtz
docs: add branch info for git convention
2102e90
@AntonioMrtz
ci: only trigger docs build when branch is closed
d3c6e6a
@AntonioMrtz
docs: add package app and fix setup frontend
e86e803
@AntonioMrtz
docs: add missing architecture section links in Enviroment
4188fc2
@AntonioMrtz
docs: add placeholder files for new docs
e7e4d5e
@AntonioMrtz
docs: add docker
0fb4dfd
@AntonioMrtz
docs: add ci/cd
800759a
@AntonioMrtz
docs: add Frontend FAQ
512f5a3
@AntonioMrtz
docs: add contributing info on selecting issue and general message fr…
ddc717d 
…om the owners to the contributors
@AntonioMrtz
docs: update renamed lambda to streaming_serverless_function and remo…
7785d39 
…ve AWS Sdk architecture
@xiomaraR @AntonioMrtz
Added health endpoint and related tests, modified authentication midd…
3f0d09b 
…leware and login router datetime.utcnow deprecation
@xiomaraR @AntonioMrtz
Initial commit
6a8d4f1
@xiomaraR @AntonioMrtz
Reverted change in imports to commit 3ef4f8c, restored .env.local fil…
0e066bd 
…e, reverted login.py to commit 3ef4f8c, reverted build_and_up_dev.sh to commit 3ef4f8c, modified magic numbers in health route files
@xiomaraR @AntonioMrtz
Revert to c33e29a - fix: restore timezone.UTC from datetime.UTC
f2176b2
@AntonioMrtz
docs: add mkdocs structure with enviroment and git convention files
c6a92c9
@AntonioMrtz
fix: rebase issues of docs
b39ee92
@xiomaraR @AntonioMrtz
Initial commit
c6556a9
@AntonioMrtz
docs: add improved draw.io architectures and restructure docs and ass…
fc2b4a7 
…ets folder hierarchy
@AntonioMrtz
docs: add ENVIROMENTS
cad6c06
@AntonioMrtz
docs: add mkdocs structure with enviroment and git convention files
d93dcb1
@AntonioMrtz
ci: add generate docs pipeline
024e860
@AntonioMrtz
ci: fix requirement install generate docs workflow
7a59ebe
@AntonioMrtz
docs: publish docs into gh-pages
605efbb
AntonioMrtz and others added 10 commits June 6, 2024 14:02
@AntonioMrtz
Copy link
Owner Author

Create Backend DOCS

@AntonioMrtz
Merge branch 'master' into docs/Project-Documentation
3fda716
@AntonioMrtz
Merge branch 'master' into docs/Project-Documentation
ae1bef3
@AntonioMrtz
feat: pre-commit docs and config on root folder
449c6fb
@AntonioMrtz
Merge branch 'master' of https://github.com/AntonioMrtz/SpotifyElectron…
51a3557 
… into docs/Project-Documentation
@AntonioMrtz
docs: add global set up and move lintin/formatting to its own files
80f42af
@AntonioMrtz
docs: fix bullet point list global setup
e4dbde8
@AntonioMrtz
revert: remove requirements-pre-commit, using requirements global ins…
f8c39b8 
…teada
@AntonioMrtz
docs: fix typos and missing emojis
b522812
@AntonioMrtz
docs: remoce cicd section from backend and improve linting and format…
9baf6b4 
…ting md
@AntonioMrtz
Merge branch 'master' into docs/Project-Documentation
d43ad2f
@AntonioMrtz
docs: improve backend tests coverage only app folder
15156ad
@AntonioMrtz
docs: backend tests Develop tests
748544c
@AntonioMrtz
docs: minor improvements
ed80856
@AntonioMrtz
docs: rename todos to WIP
75f4032
@AntonioMrtz
docs: add frontend file structure
7a538d0
@AntonioMrtz
fix: __tests__ folder recognized as md style
296cd23
@AntonioMrtz
docs: add architecture
33a06e0
@AntonioMrtz AntonioMrtz merged commit 37d1941 into master Jun 22, 2024
10 checks passed
@AntonioMrtz AntonioMrtz deleted the docs/Project-Documentation branch June 22, 2024 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@AntonioMrtz @xiomaraR