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

Refactor documentation to work with Docusaurus #497

Closed
8 tasks
Tracked by #64
beeme1mr opened this issue Mar 13, 2023 · 2 comments
Closed
8 tasks
Tracked by #64

Refactor documentation to work with Docusaurus #497

beeme1mr opened this issue Mar 13, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@beeme1mr
Copy link
Member

beeme1mr commented Mar 13, 2023

Overview

The current documentation consists of markdown files in GitHub. While this does work, it's a poor user experience. This issue is to refactor the documentation to work with Docusaurus, so it can be included in the OpenFeature docs as a subsection. The goal is to provide a user-friendly and organized documentation site that includes all the core OpenFeature projects.

Requirements

  • Refactor the current documentation to work with Docusaurus
  • Create an organized and user-friendly documentation site
  • Extend the documentation to answer the following questions:
    • What's flagd?
    • What problem does it solve?
    • What's an evaluation engine?
    • How does it relate to OpenFeature?
  • Ensure that the documentation is easy to maintain and update

Resources

Docusaurus documentation: https://docusaurus.io/docs/
Docusaurus GitHub repository: https://github.com/facebook/docusaurus
Current documentation: https://github.com/open-feature/flagd/tree/main/docs

@beeme1mr beeme1mr transferred this issue from open-feature/docs.openfeature.dev Mar 13, 2023
@beeme1mr beeme1mr changed the title FlagD Update docs for Docusaurus Mar 13, 2023
@beeme1mr beeme1mr added the documentation Improvements or additions to documentation label Mar 13, 2023
@beeme1mr beeme1mr changed the title Update docs for Docusaurus Refactor documentation to work with Docusaurus Mar 13, 2023
@agardnerIT
Copy link
Contributor

agardnerIT commented Mar 15, 2023

@StackScribe

@beeme1mr
Copy link
Member Author

beeme1mr commented Aug 4, 2023

Resolved by: #782

@beeme1mr beeme1mr closed this as completed Aug 4, 2023
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
Projects
Archived in project
Development

No branches or pull requests

2 participants