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 Request: Clean up GET STARTED Page #150

Closed
4 tasks
bms63 opened this issue Jun 7, 2023 · 0 comments · Fixed by #141
Closed
4 tasks

Feature Request: Clean up GET STARTED Page #150

bms63 opened this issue Jun 7, 2023 · 0 comments · Fixed by #141
Assignees
@bms63
Labels
documentation Improvements or additions to documentation enhancement New feature or request programming
Milestone
xportr 0.3.0

Comments

@bms63
Copy link
Collaborator

bms63 commented Jun 7, 2023 •
edited

Feature Idea

The xportr.RMD page repeats a lot of the same information in the deepdive vignette.

As it is a GET STARTED page, I think we should really reduce the volume of information in it and imagine users just wanting to Get Started. I think the structure should remain the same but we should use some simple syntethic data created in the vignette to drive the examples.

Definition of Done

  • Use scrolling chunks in outputs to reduce size
  • Reference Deep Dive Vignette for exploring warnings and error messaging
  • Remove excessive
  • Use cli options in page as well other tricks in deep dive for messaging
@bms63 bms63 added enhancement New feature or request programming labels Jun 7, 2023
@bms63 bms63 added this to the xportr 0.3.0 milestone Jun 7, 2023
@bms63 bms63 added the documentation Improvements or additions to documentation label Jun 7, 2023
bms63 added a commit that referenced this issue Jun 8, 2023
@bms63
docs: #150 removing br
b309c84
bms63 added a commit that referenced this issue Jun 8, 2023
@bms63
docs: #150 display msgs, removed additional br, improved wordflow
9e6003d 
Merge remote-tracking branch 'origin/84_xportr_deep_dive_vignette' into 150_clean_up_gs
# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
bms63 added a commit that referenced this issue Jun 8, 2023
@bms63
chore: #150 lint
93b481d
bms63 added a commit that referenced this issue Jun 8, 2023
@bms63
chore: #150 style
ba7e540
@bms63 bms63 linked a pull request Jun 13, 2023 that will close this issue
Closes #84 xportr deep dive vignette #141
Merged
14 tasks
@bms63 bms63 closed this as completed Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bms63 bms63

Labels
documentation Improvements or additions to documentation enhancement New feature or request programming
Projects
xportr 0.3.0
Status: Done
Milestone
xportr 0.3.0
Development

Successfully merging a pull request may close this issue.

Closes #84 xportr deep dive vignette atorus-research/xportr
1 participant
@bms63