-
-
Notifications
You must be signed in to change notification settings - Fork 19
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.
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
More robust project documentation #147
Labels
documentation
Improvements or additions to documentation
epic
This issue is huge and will be split into smaller issues
Milestone
Comments
stickgrinder
added
documentation
Improvements or additions to documentation
epic
This issue is huge and will be split into smaller issues
labels
Jan 5, 2024
stickgrinder
added a commit
that referenced
this issue
Jan 5, 2024
…mpose file for local inspection.
stickgrinder
added a commit
that referenced
this issue
Jan 30, 2024
stickgrinder
added a commit
that referenced
this issue
Jan 30, 2024
stickgrinder
added a commit
that referenced
this issue
Feb 8, 2024
stickgrinder
added a commit
that referenced
this issue
Feb 8, 2024
stickgrinder
added a commit
that referenced
this issue
Feb 8, 2024
stickgrinder
added a commit
that referenced
this issue
Feb 8, 2024
stickgrinder
added a commit
that referenced
this issue
Feb 8, 2024
stickgrinder
added a commit
that referenced
this issue
Feb 11, 2024
… execute it locally on Windows, Mac and Linux.
stickgrinder
added a commit
that referenced
this issue
Feb 11, 2024
* refs #147: Stubbed mkDocs-based documentation directory and docker-compose file for local inspection. * refs #147: Introduced a working version of the Godot Docs theme, plus an example page. * refs #147: Some initial additions to the docs structure. * refs #147: stubbed a bunch of pages and sections. * refs #147: stubbed all the pages and sections. * refs #147: admonitions are now supported, importers moved under editor. * refs #147: Added target directory for exported codeblock docks. * refs #147: Added support to front matter sorting, plus navigation sorted. * refs #147: Finalized the local environment, plus added README file to execute it locally on Windows, Mac and Linux.
stickgrinder
added a commit
that referenced
this issue
Feb 17, 2024
stickgrinder
added a commit
that referenced
this issue
Feb 17, 2024
stickgrinder
added a commit
that referenced
this issue
Feb 17, 2024
…king. Docs README explains how to use it.
stickgrinder
added a commit
that referenced
this issue
Feb 17, 2024
…ite. Added support for ancillary languages that may come in handy (md, bash, yaml, json, dockerfile, makefile).
stickgrinder
added a commit
that referenced
this issue
Feb 17, 2024
…ite. Added support for ancillary languages that may come in handy (md, bash, yaml, json, dockerfile, makefile).
stickgrinder
added a commit
that referenced
this issue
Feb 18, 2024
mapedorr
pushed a commit
that referenced
this issue
Feb 18, 2024
* refs #147: WIP on a custom docker image for GDQuest's gdscript-docs-maker. * refs #147: wip on the dockerfile for reference generator. * refs #147: A first version of the Code Reference generator is now working. Docs README explains how to use it. * refs #147: GDScript codeblocks are now highlighted in documentation site. Added support for ancillary languages that may come in handy (md, bash, yaml, json, dockerfile, makefile). * refs #147: Fixed typo in docs REAME.md file.
mapedorr
pushed a commit
that referenced
this issue
Feb 18, 2024
* refs #147: Stubbed mkDocs-based documentation directory and docker-compose file for local inspection. * refs #147: Introduced a working version of the Godot Docs theme, plus an example page. * refs #147: Some initial additions to the docs structure. * refs #147: stubbed a bunch of pages and sections. * refs #147: stubbed all the pages and sections. * refs #147: admonitions are now supported, importers moved under editor. * refs #147: Added target directory for exported codeblock docks. * refs #147: Added support to front matter sorting, plus navigation sorted. * refs #147: Finalized the local environment, plus added README file to execute it locally on Windows, Mac and Linux.
mapedorr
pushed a commit
that referenced
this issue
Feb 18, 2024
* refs #147: WIP on a custom docker image for GDQuest's gdscript-docs-maker. * refs #147: wip on the dockerfile for reference generator. * refs #147: A first version of the Code Reference generator is now working. Docs README explains how to use it. * refs #147: GDScript codeblocks are now highlighted in documentation site. Added support for ancillary languages that may come in handy (md, bash, yaml, json, dockerfile, makefile). * refs #147: Fixed typo in docs REAME.md file.
stickgrinder
added a commit
that referenced
this issue
Feb 25, 2024
stickgrinder
added a commit
that referenced
this issue
Feb 25, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
…ose. generated from commit 6fae0ec
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
…ontained. generated from commit 7af7af7
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
…e. Relocated docs README file. generated from commit 78617ea
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
…e. Relocated docs README file. generated from commit 78617ea
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 10, 2024
…action. README file for docs updated. generated from commit ba42dd0
mapedorr
pushed a commit
that referenced
this issue
Mar 11, 2024
* refs #147: Access to Dockerized tools is now proxied by compose. * refs #147: Fixed a WIP make target. * refs #147: Changed folder structure to make docs more self-contained. * refs #147: Typo fix. * refs #147: Renamed container and target for consistency. * refs #147: Got rid of unnecessary nesting in folder structure. Relocated docs README file. * refs #147: Added working deploy target to makefile. The docs can be safely deployed to GH Pages. * refs #147: Added MkDocs metadata for site and github direct editing link. * refs #147: Deploy procedure now forcefully triggers API extraction. README file for docs updated.
stickgrinder
added a commit
that referenced
this issue
Mar 17, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 17, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 17, 2024
…dability. Running another test. generated from commit d5f3b82
stickgrinder
added a commit
that referenced
this issue
Mar 17, 2024
…ing the last test. generated from commit 803a507
stickgrinder
added a commit
that referenced
this issue
Mar 17, 2024
stickgrinder
added a commit
that referenced
this issue
Mar 17, 2024
…he actual release, not pushes on testing branch.
mapedorr
pushed a commit
that referenced
this issue
Mar 17, 2024
…now work again (#174) * refs #173: This change should explicitely grant proper permissions to the job that creates a new release. * refs #147: Added a test workflow to deploy docs site via GH Actions. This is a test commit. * refs #147: Fixed indentation, running another test. * refs #147: Specified working dir for the deployh command, running another test. * refs #147: Specified permissions, renamed job for better readability. Running another test. * refs #147: Changed a string back to test manual deploy. Running the last test. * refs #147: The gh pages deploy workflow triggers are now related to the actual release, not pushes on testing branch.
I'm closing this because I split some tasks in more granular issues. The bulk of the docs framework is done, it's now time to move on with the content. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
epic
This issue is huge and will be split into smaller issues
Benefit description
Popochiu outgrew the incubation stage and now requires better, more mature documentation that:
From a content point of view:
Solution description
We scouted for a solution and decided to go with MkDocs for it's natively supported by RTD and can be easily deployed on GHPages.
Also, compared to Sphinx, it uses MarkDown, and its configuration is a single YAML file.
The todo-list follows:
Bring the currently available documentation to the repo(split in Documentation: Migrate the old wiki to the new repository #185)Clean up the wiki or close it entirely(split in Documentation: Migrate the old wiki to the new repository #185)Review the project's Readme to redirect to the GHPages homepage(split in New Documentation - Point the project README to the new documentation #186)Exclusions
We're not going to create a custom theme. We'll customize the logo and colors, and that's all.
Implications
This will allow contributors to add content without access to the project's wiki repo, which is way more problematic.
The text was updated successfully, but these errors were encountered: