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

[DOCS] Docs describing the API, utilization and examples of the @daffodil libraries #336

Open
1 of 36 tasks
damienwebdev opened this issue Apr 2, 2019 · 1 comment · Fixed by #750
Open
1 of 36 tasks

[DOCS] Docs describing the API, utilization and examples of the @daffodil libraries #336

damienwebdev opened this issue Apr 2, 2019 · 1 comment · Fixed by #750
Assignees
@griest024 @damienwebdev @xelaint @mackypatt
Labels
docs This issue is related to documentation hacktoberfest This PR or issue is related to Hacktoberfest p1 critical priority
Milestone
Daffodil v1.0

Comments

@damienwebdev
Copy link
Member

damienwebdev commented Apr 2, 2019 •
edited by xelaint
Loading

📄 Documentation Request

What were you doing?

I was trying to utilize any of the @daffodil packages.

Expected behavior

I would like to be able to quickly learn how to utilize the @daffodil libraries.

Existing Documentation

There isn't any, that's the issue.

Areas that need documentation coverage (Ideas List)

  • Overview
  • What's New
  • Getting Started
  • Planning/Installing
  • Maintaining/Troubleshooting
  • Resources
  • Tutorial: Sticker Shop
  • Architecture
    • Platform Independence
    • Redux Patterns
    • Glossary
  • @daffodil/design ([DOCS] Docs describing the API, utilization and examples of the @daffodil/design package #2767)
    • SCSS Usage Examples
    • SCSS API
    • SCSS Tutorials
    • Theming Guides
    • Accessibility
    • Component
      • Overview
      • Examples
  • @daffodil/product
    • Usage Examples
    • Tutorials/Guides
    • API Documentation
  • @daffodil/core
    • Usage Examples
    • Tutorials/Guides
    • API Documentation
  • @daffodil/checkout
    • Usage Examples
    • Tutorials/Guides
    • API Documentation
  • @daffodil/cart
    • Usage Examples
    • Tutorials/Guides
    • API Documentation

For those looking to do some Hacktoberfest PRs, we have a docs site that is an Angular app generated with dgeni, but it doesn't look fantastic and the docs are very incomplete. This is a great first issue and a good source of Hacktoberfest PR count!
@damienwebdev damienwebdev added the docs This issue is related to documentation label Apr 2, 2019
@damienwebdev damienwebdev assigned xelaint and unassigned xelaint Apr 2, 2019
@damienwebdev damienwebdev mentioned this issue Aug 26, 2019
Merged
3 tasks
@damienwebdev damienwebdev self-assigned this Aug 28, 2019
This was referenced Aug 30, 2019
Closed
Merged
@xelaint xelaint self-assigned this Sep 2, 2019
This was referenced Sep 8, 2019
Merged
Closed
@damienwebdev damienwebdev mentioned this issue Apr 7, 2020
Merged
3 tasks
@damienwebdev damienwebdev linked a pull request Apr 9, 2020 that will close this issue
build(daffio): moved daffio release pipeline into yaml #750
Merged
3 tasks
@damienwebdev damienwebdev reopened this Apr 9, 2020
@damienwebdev damienwebdev added the hacktoberfest This PR or issue is related to Hacktoberfest label Oct 1, 2020
@damienwebdev damienwebdev pinned this issue Oct 1, 2020
@damienwebdev damienwebdev changed the title [DOCS] Docs describing the API, utilization and examples of the @daffodil libraries [Hacktoberfest] [DOCS] Docs describing the API, utilization and examples of the @daffodil libraries Oct 1, 2020
@damienwebdev damienwebdev changed the title [Hacktoberfest] [DOCS] Docs describing the API, utilization and examples of the @daffodil libraries [DOCS] Docs describing the API, utilization and examples of the @daffodil libraries Nov 11, 2020
This was referenced Jan 25, 2021
Merged
Closed
@xelaint xelaint mentioned this issue Apr 13, 2022
Merged
3 tasks
@xelaint xelaint mentioned this issue Sep 7, 2022
Merged
3 tasks
@AnnieMi888 AnnieMi888 added the p1 critical priority label Dec 19, 2023
This was referenced Dec 20, 2023
Closed
Open
@damienwebdev
Copy link
Member Author

We should review https://documentation.divio.com/

@xelaint xelaint mentioned this issue Jun 6, 2024
Closed
3 tasks
@xelaint xelaint unpinned this issue Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@griest024 griest024

@damienwebdev damienwebdev

@xelaint xelaint

@mackypatt mackypatt

Labels
docs This issue is related to documentation hacktoberfest This PR or issue is related to Hacktoberfest p1 critical priority
Projects
No open projects
Daffodil Docs
Status: No status
Milestone
Daffodil v1.0
Development

Successfully merging a pull request may close this issue.

build(daffio): moved daffio release pipeline into yaml graycoreio/daffodil
5 participants
@griest024 @damienwebdev @xelaint @mackypatt @AnnieMi888