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

docs: 📃 initial version of the documentation #31

Merged
merged 18 commits into from
Feb 24, 2025
Merged

docs: 📃 initial version of the documentation #31

merged 18 commits into from
Feb 24, 2025

Conversation

Diegomcha
Copy link

@Diegomcha Diegomcha commented Feb 23, 2025 •
edited by uo288499
Loading

Goal

Add the first version of the documentation to master.

Tasks

uo288499 and others added 10 commits February 22, 2025 20:31
@uo288499
Introduction and logo
776dce8 
Added the firts part of the introduction and the logo for the web app
@uo288499
Added Stakeholders
bd7dd05 
Stakeholders table from Introduction updated and fullfiled
@uo288499
Added qualoty goals
fb4e709 
Quality goals table with concrete scenarios have been created and filled.
@fercalonso
Update 06_runtime_view.adoc
708ab37 
06 - RunTime view of the application, first version of the diagrams.
@UO288992
Context and Scope added to documentation.
28b4e92
@UO288992
Solution Strategy added to documentation.
3571b56
@Diegomcha
docs(building_block_view): 📝 initial version of building block view
2c52fa0 
Game Service is missing Level 2 view

Signed-off-by: Diego <[email protected]>
@UO288992
Updated diagarms in 03_context_and_scope.adoc and minor changes and d…
2981a6b 
…eleted typos in 04_solution_strategy.adoc
@UO288992
Merge branch 'docs' of https://github.com/Arquisoft/wichat_en1c into …
a02deca 
…docs
@Diegomcha
docs(building_block_view): 📝 finished documentation iteration
e035c01 
Signed-off-by: Diego <[email protected]>
@Diegomcha Diegomcha added 📃 type: docs Improvements or additions to documentation 🏛️ cat: design Design related that needs to be decided by the team labels Feb 23, 2025
@Diegomcha Diegomcha requested a review from a team February 23, 2025 19:36
@Diegomcha Diegomcha linked an issue Feb 23, 2025 that may be closed by this pull request
Write documentation #19
Closed
@Diegomcha Diegomcha mentioned this pull request Feb 23, 2025
Open
@HopeDolangac HopeDolangac marked this pull request as ready for review February 23, 2025 20:13
Diegomcha and others added 2 commits February 23, 2025 21:43
@Diegomcha @HopeDolangac
docs(arq_constraints): 📝 added arquitecture constraints
30f334c 
Co-authored-by: HopeDolangac <[email protected]>
Signed-off-by: Diego <[email protected]>
@uo288499
Added requirements overview and annex
6fad121 
Some corrections were done for quality goals. An initial version of the requirements has been made. A new section called annex has been added and it contains the functional requirements.
Diegomcha
Diegomcha commented Feb 23, 2025
View reviewed changes
Copy link
Author

@Diegomcha Diegomcha left a comment

Choose a reason for hiding this comment

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

I have to go sleep, I leave you here this partial review and a few comments. Good night!

Diegomcha and others added 5 commits February 24, 2025 00:10
@Diegomcha
docs(building_block_view): 📝 clarified why Level 3 is empty
e5f80e1 
Signed-off-by: Diego <[email protected]>
@uo288499
Added Deployment View
7cbfbfc 
Level 1 Infrastructure of deployment view has been done
@uo288499
Quick fixes
ddbdfb6 
Fixed image and list
@uo288499
Second quick fix
c22e031 
Image and mails changed
@uo288499
Possible fix to plantUML diagrams
e74ca39 
Removed extra spaces after participants declarations
UO288992
UO288992 approved these changes Feb 24, 2025
View reviewed changes
Copy link

@UO288992 UO288992 left a comment

Choose a reason for hiding this comment

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

Now the diagram is visible and there is no problem in the documentation.

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@uo288499 uo288499 self-requested a review February 24, 2025 00:04
uo288499
uo288499 approved these changes Feb 24, 2025
View reviewed changes
Copy link

@uo288499 uo288499 left a comment

Choose a reason for hiding this comment

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

After some fixes, we were able to finally solve the problems.

@UO288992 UO288992 merged commit 774aeb2 into master Feb 24, 2025
3 checks passed
@uo288499 uo288499 mentioned this pull request Feb 24, 2025
Open
@UO288992 UO288992 mentioned this pull request Feb 27, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@UO288992 UO288992 UO288992 approved these changes

@HopeDolangac HopeDolangac HopeDolangac approved these changes

@uo288499 uo288499 uo288499 approved these changes

Assignees

@Diegomcha Diegomcha

@HopeDolangac HopeDolangac

@uo288499 uo288499

@fercalonso fercalonso

@UO288992 UO288992

Labels
🏛️ cat: design Design related that needs to be decided by the team 📃 type: docs Improvements or additions to documentation
Projects
None yet
Milestone
1. Documentation v0.1 + 1st deployment
Development

Successfully merging this pull request may close these issues.

Write documentation
5 participants
@Diegomcha @HopeDolangac @uo288499 @UO288992 @fercalonso