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.

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

Closed
6 tasks done
stickgrinder opened this issue Jan 5, 2024 · 1 comment
Closed
6 tasks done

More robust project documentation #147

stickgrinder opened this issue Jan 5, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation epic This issue is huge and will be split into smaller issues
Milestone

Comments

@stickgrinder
Copy link
Collaborator

stickgrinder commented Jan 5, 2024

Benefit description

Popochiu outgrew the incubation stage and now requires better, more mature documentation that:

  • Provides a user experience on par with Godot itself so that users will feel at home
  • Can be hosted on GitHub Pages (or ReadTheDocs if we decide to use it in the future; that's where Godot's docs belong)
  • It's sourced from the same repository as the project itself so that we can enforce documentation writing in our Definition of Done for new features or breaking changes
  • It's based on MarkDown, so we can make use of the work that's already been done
  • Can be partially generated automatically from code comments (see Documentation: Add code documentation comments to the engine #133) without breaking manual contributions
  • Supports switch for different engine releases/versions
  • Can be deployed to a subdirectory or subdomain in GHPages in case we want to add a Popochiu website at root level in the future

From a content point of view:

  • is LOOSELY based on the concepts of the Diataxis framework, to the larger possible extent
  • can be properly organized and themed depending on the project's needs

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:

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.

@stickgrinder 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 stickgrinder added this to the v2.0 - Stable milestone Jan 5, 2024
@stickgrinder stickgrinder self-assigned this Jan 5, 2024
stickgrinder added a commit that referenced this issue Jan 5, 2024
stickgrinder added a commit that referenced this issue Jan 10, 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
…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).
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
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
…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
…action. README file for docs updated.

generated from commit ba42dd0
stickgrinder added a commit that referenced this issue Mar 10, 2024
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
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.
@stickgrinder
Copy link
Collaborator Author

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
Projects
None yet
Development

No branches or pull requests

1 participant