StarOpenSource/Engine
2
0
Fork 1
Code Issues 5 Pull requests Releases 5 Activity Actions

feat: documentation #8

New issue
Open
opened 2024-08-21 21:02:48 +02:00 by JeremyStarTM · 0 comments
JeremyStarTM commented 2024-08-21 21:02:48 +02:00
Owner
Copy link

Feature description

A proper documentation.

Feature implementation

The documentation should contain the following things:

  • Getting started guide
  • In-Depth tutorials for various things (e.g. dependency resolving)
  • Information about internals
  • Development information
  • Architecture overview

Feature alternatives

No response

### Feature description A proper documentation. ### Feature implementation The documentation should contain the following things: - Getting started guide - In-Depth tutorials for various things (e.g. dependency resolving) - Information about internals - Development information - Architecture overview ### Feature alternatives _No response_
JeremyStarTM added the
FeatureRequest
New
 label 2024-08-21 21:02:48 +02:00
JeremyStarTM added this to the v1-release0 milestone 2024-09-04 21:19:59 +02:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
develop
stable
v1-alpha4
v1-alpha3
v1-alpha2
v1-alpha1
v1-alpha0
Labels
Clear labels
  
Blocked
ByBug
Implementing a feature request is blocked by a bug.

  
Blocked
ByDependency
Implementing a feature request or fixing a bug report is blocked by a dependency.

  
Blocked
ByMissingFeature
Implementing a feature request or fixing a bug report is blocked by a missing feature in the project.

  
Bug
Accepted
Marks a bug report as valid and reproduced. Development on a fix will soon start.

  
Bug
Fixed
Marks a bug report as resolved and it's bug fixed.

  
Bug
In Progress
Development on a fix for the bug mentioned in the bug report has started.

  
Bug
Invalid
An invalid bug report.

  
Bug
ItWorksOnMyMachine
Marks a bug report as unreproducable, making it invalid.

  
Bug
MoreInvestigation
A bug report which requires more investigation before it is accepted or marked as invalid.

  
Bug
New
A wild bug report appeared!

  
Empty

An empty issue. For specific, special cases only.

  
FeatureRequest
Accepted
Marks a feature request as valid. Development will start soon.

  
FeatureRequest
Implemented
Marks a feature request resolved and it's feature implemented.

  
FeatureRequest
In Progress
Development on the feature mentioned in the feature request has started.

  
FeatureRequest
Invalid
An invalid feature request.

  
FeatureRequest
New
A wild feature request appeared!

  
FeatureRequest
PartiallyImplemented
A feature request has been partially implemented. See the issue discussion for more information.

  
FeatureRequest
WontAdd
Marks a feature request as rejected, for one reason or another.

  
Important

An important issue or pull request.

  
PR
BranchMerge
A pull request which merges two branches together.

  
PR
BugFix
A pull request which aims at fixing one or multiple bugs.

  
PR
Documentation
A pull request which adds or updates documentation.

  
PR
FeatureAddition
A pull request which adds one or multiple features.

  
PR
Miscellaneous
A pull request which adds, changes or removes miscellaneous things.

  
PR
Mixed
A pull request which covers multiple categories.

  
PR
New
A wild pull request appeared!

  
PR
Tests
A pull request which adds or updates unit tests.

  
PR
Update
A pull request which updates dependencies or release branches (ie. stable, v/<version>).

  
Roadmap

Used exclusively for roadmaps.

  
Stale

Marks an issue or pull request as inactive.

No labels
Blocked
ByBug
Blocked
ByDependency
Blocked
ByMissingFeature
Bug
Accepted
Bug
Fixed
Bug
In Progress
Bug
Invalid
Bug
ItWorksOnMyMachine
Bug
MoreInvestigation
Bug
New
Empty
FeatureRequest
Accepted
FeatureRequest
Implemented
FeatureRequest
In Progress
FeatureRequest
Invalid
FeatureRequest
New
FeatureRequest
PartiallyImplemented
FeatureRequest
WontAdd
Important
PR
BranchMerge
PR
BugFix
PR
Documentation
PR
FeatureAddition
PR
Miscellaneous
PR
Mixed
PR
New
PR
Tests
PR
Update
Roadmap
Stale
Milestone
Clear milestone
No items
No milestone
v1-release0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference: StarOpenSource/Engine#8
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?