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

docs: add "How to Build Shield Documentation" #862

Merged
merged 1 commit into from
Sep 29, 2023

Conversation

kenjis
Copy link
Member

@kenjis kenjis commented Sep 28, 2023

Description

  • add "How to Build Shield Documentation"

Checklist:

  • Securely signed commits
  • [] Component(s) with PHPDoc blocks, only if necessary or adds value
  • [] Unit testing, with >80% coverage
  • [] User guide updated
  • [] Conforms to style guide

@@ -0,0 +1,26 @@
# How to Build Shield Documentation
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use Material for MkDocs for implementation. It is better to add the description in this section that includes the line as follows.
https://squidfunk.github.io/mkdocs-material/getting-started/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.


```consolse
mkdocs serve
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Command mkdocs gh-deploy is also good for manual implementation if there is a problem. Of course, I think it needs administrator access.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have previously named the files as follows.
how_to_build_docs.md

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Collaborator

@datamweb datamweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! 🥀

@datamweb datamweb merged commit cc2a25b into codeigniter4:develop Sep 29, 2023
1 check passed
@kenjis kenjis deleted the docs-HowToBuildDocs branch September 29, 2023 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants