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.

Sign up for GitHub

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

Jump to bottom

Documentation - GitHub Pages - Create Technical Documentation as GitHub Pages #14

Open
MohamedRadwan-DevOps opened this issue Sep 13, 2024 · 0 comments
Open

Documentation - GitHub Pages - Create Technical Documentation as GitHub Pages #14

MohamedRadwan-DevOps opened this issue Sep 13, 2024 · 0 comments
Assignees
@RehabAbotalep
Labels
documentation Improvements or additions to documentation

Comments

@MohamedRadwan-DevOps
Copy link
Member

MohamedRadwan-DevOps commented Sep 13, 2024 •
edited
Loading

Generating technical documentation from C# code using DocFX and deploying it to GitHub Pages. It includes setting up DocFX, customizing the documentation layout, and configuring the GitHub repository for hosting. The goal is to provide a professional and accessible documentation site that reflects the project's codebase.

Take into consideration to use this GitHub Notes Highlight:
https://github.com/orgs/community/discussions/16925
And the output should be something similar to this (image below):
https://learn.microsoft.com/en-us/cli/azure/get-started-tutorial-3-use-variables?tabs=bash

Some of the consideration:

  • Only document public methods that will be used by consumers
  • Silent mode and all its methods are very important
  • Creating one website for each framework or toolkit or creating one website for all and subsites for each one under the main website.

Image
@MohamedRadwan-DevOps MohamedRadwan-DevOps converted this from a draft issue Sep 13, 2024
@MohamedRadwan-DevOps MohamedRadwan-DevOps moved this from 🆕 New to 🔖 Ready in WordPress Automation Toolkit Sep 13, 2024
@MohamedRadwan-DevOps MohamedRadwan-DevOps added the documentation Improvements or additions to documentation label Sep 13, 2024
RehabAbotalep added a commit that referenced this issue Sep 13, 2024
@RehabAbotalep
Add DocFX documentation and deploy to GitHub Pages
296955d 
Fixes #14

Add technical documentation generation and deployment using DocFX and GitHub Pages.

- **DocFX Configuration:**
  - Add `docfx.json` to configure DocFX for generating documentation.
  - Include metadata, source code directories, and output directory.

- **Documentation Content:**
  - Add `index.md` as the main landing page.
  - Add `overview.md`, `getting-started.md`, `configuration.md`, `deployment.md`, `troubleshooting.md`, and `faq.md` for detailed documentation sections.

- **Customization:**
  - Add `custom.css` for custom styles.
  - Add `custom.html` for custom layout.

- **GitHub Pages Deployment:**
  - Add `.github/workflows/deploy-docs.yml` to automate documentation deployment to GitHub Pages using GitHub Actions.

- **README Update:**
  - Update `README.md` to include instructions for generating and accessing the documentation.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/DevOpsVisions/wordpress-automation-toolkit/issues/14?shareId=XXXX-XXXX-XXXX-XXXX).
@RehabAbotalep RehabAbotalep mentioned this issue Sep 13, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@RehabAbotalep RehabAbotalep

Labels
documentation Improvements or additions to documentation
Projects
WordPress Automation Toolkit
Status: 🔖 Ready
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add DocFX documentation and deploy to GitHub Pages DevOpsVisions/wordpress-automation-toolkit
2 participants
@MohamedRadwan-DevOps @RehabAbotalep