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

Feature: Rework documentation and README #14

Closed
3 tasks
t3hmrman opened this issue Feb 12, 2023 · 0 comments · Fixed by #34
Closed
3 tasks

Feature: Rework documentation and README #14

t3hmrman opened this issue Feb 12, 2023 · 0 comments · Fixed by #34
Labels
documentation Improvements or additions to documentation dx Developer Experience enhancement New feature or request help wanted Extra attention is needed important

Comments

@t3hmrman
Copy link
Member

Context

Instructions in the README are not functional enough.

Proposal

There are a few things to do:

  • move developer specific things (ex. local docker configuration, direnv, etc) to docs/local-dev.md or some similar file
  • Remove all non-working links
  • Simplify install instructions, possibly similar to pg_jsonschema

Alternatives

Could completely mirror the documentation from pg_jsonschema

Additional Links

N/A
@t3hmrman t3hmrman added documentation Improvements or additions to documentation enhancement New feature or request dx Developer Experience labels Feb 12, 2023
@t3hmrman t3hmrman added the help wanted Extra attention is needed label Oct 30, 2023
@t3hmrman t3hmrman mentioned this issue Nov 29, 2023
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation dx Developer Experience enhancement New feature or request help wanted Extra attention is needed important
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

refactor(docs): rework README VADOSWARE/pg_idkit
1 participant
@t3hmrman