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 proper documentation for user-facing features #132

Closed
wants to merge 9 commits into from

Conversation

rogermparent
Copy link
Contributor

@rogermparent rogermparent commented Nov 21, 2022

This PR has two main goals:

  • Remove the current dummy docs which are an old copy of dvc.org's
  • Use our current examples page as a basis for theme docs that this site will be dedicated to, fixing document features #17
  • Copy over dvc.org contribution docs

If any glaring flaws are discovered in feature code and can be handled quickly, I'll consider fixing them and documenting so in this PR. Larger issues that could delay these docs will be noted and handled in follow-ups.

@rogermparent rogermparent temporarily deployed to gatsby-theme-proper-doc-nupkl4 November 21, 2022 01:48 Inactive
@rogermparent rogermparent temporarily deployed to gatsby-theme-proper-doc-wkwnws November 21, 2022 03:00 Inactive
@yathomasi
Copy link
Contributor

If any glaring flaws are discovered, they'll be fixed and documented in this PR unless it makes more sense to do otherwise.

I have been doing that https://gatsby-theme-iterative-example.herokuapp.com/doc/examples. We can continue documenting any feature we fix/add/update.

@rogermparent rogermparent self-assigned this Nov 21, 2022
@rogermparent
Copy link
Contributor Author

rogermparent commented Nov 21, 2022

I see you have, and it's definitely a step in the right direction, but we probably want to elaborate more on the docs to the point where we give each feature its own page instead of having one mega-page for all features hidden among all the dummy docs. That work won't go to waste, though! it's a great starting point for where we want to go with this docs site.

The quote you have was also more directed toward the features themselves: if I discover a glaring flaw while writing documentation, that code may be fixed in this PR. It could also go the other way if the fix seems like too much to put in here- we can document the issue and follow up on it.

@rogermparent rogermparent temporarily deployed to gatsby-theme-proper-doc-sijh8q February 14, 2023 20:35 Inactive
@rogermparent rogermparent temporarily deployed to gatsby-theme-proper-doc-sijh8q February 15, 2023 17:34 Inactive
@rogermparent rogermparent had a problem deploying to gatsby-theme-proper-doc-sijh8q February 15, 2023 17:44 Failure
@yathomasi
Copy link
Contributor

Thanks @rogermparent. Closing this as I don't see it's being updated any time soon.

@yathomasi yathomasi closed this Jun 16, 2023
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