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

Add DocFX documentation and deploy to GitHub Pages #15

Closed
wants to merge 1 commit into from

Conversation

RehabAbotalep
Copy link
Member

@RehabAbotalep RehabAbotalep commented Sep 13, 2024

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.

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 deleted the RehabAbotalep/add-docfx-docs branch September 13, 2024 13:01
@RehabAbotalep RehabAbotalep restored the RehabAbotalep/add-docfx-docs branch September 13, 2024 13:01
@RehabAbotalep RehabAbotalep deleted the RehabAbotalep/add-docfx-docs branch September 13, 2024 13:02
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.

Documentation - GitHub Pages - Create Technical Documentation as GitHub Pages
1 participant