linarphy/galaxy-graph
1
0
Fork 0
Code Issues 5 Pull requests Projects 1 Releases 1 Packages 1 Wiki Activity Actions

Update Reference API #11

New issue
Closed
opened 2026-05-26 20:57:07 +00:00 by linarphy · 4 comments
linarphy commented 2026-05-26 20:57:07 +00:00
Owner
Copy link

Update the Reference API available on the wiki. (Continuity of # 1 )

Update the Reference API available on the wiki. (Continuity of # 1 )
linarphy added this to the Documentation milestone 2026-05-26 20:57:07 +00:00
linarphy added the due date 2026-05-29 2026-05-26 20:57:17 +00:00
linarphy commented 2026-05-26 20:59:04 +00:00
Author
Owner
Copy link

(and README)

(and README)
linarphy commented 2026-05-29 22:32:45 +00:00
Author
Owner
Copy link

I think using Mardown is a limitation for technical documentation (for which restructured text shine).

I see two possibilities here:

  • Keep a semi-lightweight documentation in the wiki (I love using all the functionalities of forgejo), reference API will be available in an external website, available on the wiki.
  • Remove the wiki and add an external one.

For now I prefer the first one (as I say, It exploit a cool feature), but this mean I should define what goes in the wiki and what goes in the external website.

I think using Mardown is a limitation for technical documentation (for which restructured text shine). I see two possibilities here: - Keep a semi-lightweight documentation in the wiki (I love using all the functionalities of forgejo), reference API will be available in an external website, available on the wiki. - Remove the wiki and add an external one. For now I prefer the first one (as I say, It exploit a cool feature), but this mean I should define what goes in the wiki and what goes in the external website.
linarphy modified the due date from 2026-05-29 to 2026-05-31 2026-05-29 22:33:04 +00:00
linarphy commented 2026-05-30 14:50:54 +00:00
Author
Owner
Copy link

I changed my mind over this night. I feel like a website for this library can offer more things than just hosting the reference API.

I changed my mind over this night. I feel like a website for this library can offer more things than just hosting the reference API.
linarphy commented 2026-05-31 02:12:48 +00:00
Author
Owner
Copy link

Fixed with the creation of https://git.linarphy.net/linarphy/galaxy-graph_doc .

Fixed with the creation of https://git.linarphy.net/linarphy/galaxy-graph_doc .
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
1.1.3
1.1.1
1.1.0
1.0.0
0.3.3
0.3.2
0.3.1
0.2.1
0.1.1
0.1.0
0.0.8
0.0.7
0.0.6
0.0.4
0.0.3
Labels
Clear labels   
Complexity/Higest
More than one week of work

  
Complexity/High
Less than one week of work

  
Complexity/Low
Less than one hour of work

  
Complexity/Lowest
less than one minute of work

  
Complexity/Normal
Less than one day of work

  
Importance/High
There is negative effect if this item is forgotten

  
Importance/Highest
This item is critical to the project

  
Importance/Low
There is no negative effect of forgetting about this item

  
Importance/Lowest
Item is not considered as something that must be reacted to. It may have a reaction if someone has the time and the energy

  
Importance/Normal
Default importance. Forgetting this item may have bad negative effect

  
Kind/Bug
Unexpected output

  
Kind/Documentation
Something is not well documented

  
Kind/Feature
New functionality for the library

  
Kind/Structure
About the structure of the library and its classes

  
OS/Linux
Specific to (GNU)Linux Operating System

  
OS/MacOS
Specific to the Mac Operating System

  
OS/Windows
Specific to the Windows Operating System

No labels
Complexity/Higest
Complexity/High
Complexity/Low
Complexity/Lowest
Complexity/Normal
Importance/High
Importance/Highest
Importance/Low
Importance/Lowest
Importance/Normal
Kind/Bug
Kind/Documentation
Kind/Feature
Kind/Structure
OS/Linux
OS/MacOS
OS/Windows
Milestone
Clear milestone
No items
No milestone
Documentation
Projects
Clear projects
No items
No project
Roadmap to 1.0.0
Assignees
Clear assignees
No assignees
linarphy
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

2026-05-31

Dependencies

No dependencies set.

Reference
linarphy/galaxy-graph#11
No description provided.