Andras/BoundlessFlowCampus2K
4
7
Fork 0
Code Issues 90 Pull requests 7 Projects Releases Packages Wiki Activity Actions

Add API documentation about sudoku API in wiki #1145

New issue
Closed
opened 2026-05-25 12:48:05 +00:00 by a24julot · 14 comments
a24julot commented 2026-05-25 12:48:05 +00:00
Collaborator
Copy link
No description provided.
image.png
7.9 KiB
image.png
c24danli commented 2026-05-25 12:52:29 +00:00
Collaborator
Copy link

Reserch in: Implement Sudoku view #377
Dosuku used

Reserch in: Implement Sudoku view #377 Dosuku used
b24krila commented 2026-05-25 12:59:13 +00:00
Collaborator
Copy link

For easy access Wiki page:

For easy access [Wiki page:](https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/API-Suduko)
b24krila commented 2026-05-26 11:19:28 +00:00
Collaborator
Copy link

Would like a review to check if everythings correct and if the issue is complete or if there's more to add.

Would like a review to check if everythings correct and if the issue is complete or if there's more to add.
a24julot commented 2026-05-26 11:43:17 +00:00
Author
Collaborator
Copy link

Requesting review from @a24timsv

Requesting review from @a24timsv
😕 1
a24timsv commented 2026-05-26 12:54:33 +00:00
Collaborator
Copy link

I can't speak of the content since I wasn't the one implementing it, if not too much of a hassle, I would request a review from @b24idalu regarding the content alone.

But I can speak about the structure of the page. I feel as like the page is not divided in a similarly to the other API documentations. Using smaller headers inside other headers to show relation to other headings, for example. Code blocks should also have a language related to them so they get color. Unnecessary use of lists. Stuff like that.

I can't speak of the content since I wasn't the one implementing it, if not too much of a hassle, I would request a review from @b24idalu regarding the content alone. But I can speak about the structure of the page. I feel as like the page is not divided in a similarly to the other API documentations. Using smaller headers inside other headers to show relation to other headings, for example. Code blocks should also have a language related to them so they get color. Unnecessary use of lists. Stuff like that.
b24krila commented 2026-05-26 13:08:39 +00:00
Collaborator
Copy link

Ok, will work on the structure then.

Ok, will work on the structure then.
b24idalu commented 2026-05-26 13:23:26 +00:00
Collaborator
Copy link

Content seems good, but maybe a bit excessive about the functions that the view has since it is supposed to be about the api. Do not know if it is worth adding, but there can be alternative options in the dosuku fetch. For example amount of boards retrieved, if it should include text about which difficulty it is or if it should supply a solution (but some games have multiple solutions).

Content seems good, but maybe a bit excessive about the functions that the view has since it is supposed to be about the api. Do not know if it is worth adding, but there can be alternative options in the dosuku fetch. For example amount of boards retrieved, if it should include text about which difficulty it is or if it should supply a solution (but some games have multiple solutions).
b24krila commented 2026-05-27 09:29:12 +00:00
Collaborator
Copy link

@b24idalu wrote in #1145 (comment):

Content seems good, but maybe a bit excessive about the functions that the view has since it is supposed to be about the api. Do not know if it is worth adding, but there can be alternative options in the dosuku fetch. For example amount of boards retrieved, if it should include text about which difficulty it is or if it should supply a solution (but some games have multiple solutions).

Currently from my understanding the view uses a single randomized board without difficulty or data solution so i was/am unsure if i should include unused API features. So my question is should i write about the different APIs:

image

@b24idalu wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/1145#issuecomment-14349: > Content seems good, but maybe a bit excessive about the functions that the view has since it is supposed to be about the api. Do not know if it is worth adding, but there can be alternative options in the dosuku fetch. For example amount of boards retrieved, if it should include text about which difficulty it is or if it should supply a solution (but some games have multiple solutions). Currently from my understanding the view uses a single randomized board without difficulty or data solution so i was/am unsure if i should include unused API features. So my question is should i write about the different APIs: ![image](/attachments/5ebe0dee-d2bc-44ef-a199-a8a1d3bd2721)
image.png
40 KiB
a24julot commented 2026-05-27 10:17:59 +00:00
Author
Collaborator
Copy link

@b24krila wrote in #1145 (comment):

@b24idalu wrote in #1145 (comment):

Content seems good, but maybe a bit excessive about the functions that the view has since it is supposed to be about the api. Do not know if it is worth adding, but there can be alternative options in the dosuku fetch. For example amount of boards retrieved, if it should include text about which difficulty it is or if it should supply a solution (but some games have multiple solutions).

Currently from my understanding the view uses a single randomized board without difficulty or data solution so i was/am unsure if i should include unused API features. So my question is should i write about the different APIs:

image

You can simply document the one we are using, but you can mention that there are other options as well, but you do not have to go into detail on the things we are not using.

@b24krila wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/1145#issuecomment-14560: > @b24idalu wrote in #1145 (comment): > > > Content seems good, but maybe a bit excessive about the functions that the view has since it is supposed to be about the api. Do not know if it is worth adding, but there can be alternative options in the dosuku fetch. For example amount of boards retrieved, if it should include text about which difficulty it is or if it should supply a solution (but some games have multiple solutions). > > Currently from my understanding the view uses a single randomized board without difficulty or data solution so i was/am unsure if i should include unused API features. So my question is should i write about the different APIs: > > [![image](/attachments/5ebe0dee-d2bc-44ef-a199-a8a1d3bd2721)](/Andras/BoundlessFlowCampus2K/attachments/5ebe0dee-d2bc-44ef-a199-a8a1d3bd2721) You can simply document the one we are using, but you can mention that there are other options as well, but you do not have to go into detail on the things we are not using.
b24krila commented 2026-05-27 10:19:38 +00:00
Collaborator
Copy link

@a24julot wrote in #1145 (comment):

@b24krila wrote in #1145 (comment):

@b24idalu wrote in #1145 (comment):

Content seems good, but maybe a bit excessive about the functions that the view has since it is supposed to be about the api. Do not know if it is worth adding, but there can be alternative options in the dosuku fetch. For example amount of boards retrieved, if it should include text about which difficulty it is or if it should supply a solution (but some games have multiple solutions).

Currently from my understanding the view uses a single randomized board without difficulty or data solution so i was/am unsure if i should include unused API features. So my question is should i write about the different APIs:
image

You can simply document the one we are using, but you can mention that there are other options as well, but you do not have to go into detail on the things we are not using.

yepp i have added a part where i list the one we are using but i could add a short section at the bottom where i can list the rest nad basically just say what uses they have "basically i take what the site has written"

@a24julot wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/1145#issuecomment-14590: > @b24krila wrote in #1145 (comment): > > > @b24idalu wrote in #1145 (comment): > > > Content seems good, but maybe a bit excessive about the functions that the view has since it is supposed to be about the api. Do not know if it is worth adding, but there can be alternative options in the dosuku fetch. For example amount of boards retrieved, if it should include text about which difficulty it is or if it should supply a solution (but some games have multiple solutions). > > > > > > Currently from my understanding the view uses a single randomized board without difficulty or data solution so i was/am unsure if i should include unused API features. So my question is should i write about the different APIs: > > [![image](/attachments/5ebe0dee-d2bc-44ef-a199-a8a1d3bd2721)](/Andras/BoundlessFlowCampus2K/attachments/5ebe0dee-d2bc-44ef-a199-a8a1d3bd2721) > > You can simply document the one we are using, but you can mention that there are other options as well, but you do not have to go into detail on the things we are not using. yepp i have added a part where i list the one we are using but i could add a short section at the bottom where i can list the rest nad basically just say what uses they have "basically i take what the site has written"
a24julot commented 2026-05-27 10:36:14 +00:00
Author
Collaborator
Copy link

That sounds good @b24krila !

That sounds good @b24krila !
b24krila commented 2026-05-27 11:28:33 +00:00
Collaborator
Copy link

The wiki is done. @a24timsv has reviewed the structure and edited some parts. Would be good to have a content review by @b24idalu before saying that the wiki is done.

The wiki is done. @a24timsv has reviewed the structure and edited some parts. Would be good to have a content review by @b24idalu before saying that the wiki is done.
b24idalu commented 2026-05-27 12:00:13 +00:00
Collaborator
Copy link

Looks good!

Looks good!
c24danli commented 2026-05-27 12:02:32 +00:00
Collaborator
Copy link

As we are satisfied i will now close the issue

As we are satisfied i will now close the issue
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
#1236-edit-mode-txt
#1229-generic-themed-buttons
Add-an-option-to-set-no-image-to-image-view-1227
#1242-prog-bar-colors-fix
#1239-Remove-Vertical-Scroll
Image-view-error-1230
Make-the-card-title-and-header-of-card-uniform-1233
both_teams_week_8
team_2_week_7
team_1_week_7
temp_branch_week_7
team_2_week_6
team_1_week_6
team_2_week_5
team_1_week_5
temp_branch_week_5
team_2_week_4
team_1_week_4
week_4_temp_branch
temp-branch-week-3
team_2_week_3
team_1_week_3
team_2_week_2
team_1_week_2
temp-week-2-merge-branch
team_2_week_1
team_1_week_1
No results found.
Labels
Clear labels   
_CRITICAL_

Only use this label for critical tasks that are project-scope,and must be addressed ASAP.

  
API

   
app

   
backEnd

   
Blocked, waiting for further changes

   
bug

Something is not working

  
cleanup

Issues to cleanup the codebase (restructure folders, remove deprecated or smelly code)

  
close

Issue to close

  
design

   
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
feature request

   
frontEnd

   
help wanted

Need some help

  
invalid

Something is wrong

  
low priority

   
needs input

Issue needs input from product owner or customer

  
needs review

issue is in need of review

  
project documentation

   
question

More information is needed

  
research

   
reviewed

This Issue has been reviewed

  
script

   
security

use this for security-related issues

  
SQL

  
style

   
testing

   
topLevel

Reserved for top-level, project-wide issues.

  
wontfix

This won't be fixed

No labels
_CRITICAL_
API
app
backEnd
Blocked, waiting for further changes
bug
cleanup
close
design
duplicate
enhancement
feature request
frontEnd
help wanted
invalid
low priority
needs input
needs review
project documentation
question
research
reviewed
script
security
SQL
style
testing
topLevel
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
b24krila
5 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Andras/BoundlessFlowCampus2K#1145
No description provided.