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

[docs] Update the instructions for getting the docs web server running locally in its current state #1184

Merged
merged 7 commits into from
Nov 21, 2023

Conversation

lsgunnlsgunn
Copy link
Contributor

@lsgunnlsgunn lsgunnlsgunn commented Nov 6, 2023

In setting up my own local development environment for the docs application, I needed to do a little more than captured in the original ReadMe (Asana task https://app.asana.com/0/1205619636589593/1205727631325168).
I edited the content based on my experience (and Albert's help sorting out my environment) so far. This PR doesn't cover the actual contribution process or anything about how to make changes to the information architecture.
Asana task: https://app.asana.com/0/1205619636589593/1205997198575555
pnpm test fails for me:

@kadena/chainwebjs#test: command (/Users/lisagunn/KADENA/kadena.js/packages/libs/chainwebjs) pnpm run test run --coverage exited (-1)

 Tasks:    33 successful, 41 total
Cached:    0 cached, 41 total
  Time:    1m40.553s 
Failed:    @kadena/chainwebjs#test

 ERROR  run failed: command  exited (1)
 ELIFECYCLE  Test failed. See above for more details.

I'm not sure what to do about it.

Copy link

changeset-bot bot commented Nov 6, 2023

🦋 Changeset detected

Latest commit: 4313dbb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@kadena/docs Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Nov 6, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
alpha-docs ✅ Ready (Inspect) Visit Preview Nov 21, 2023 8:41am
docs-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2023 8:41am
2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
react-ui ⬜️ Ignored (Inspect) Visit Preview Nov 21, 2023 8:41am
tools ⬜️ Ignored (Inspect) Visit Preview Nov 21, 2023 8:41am

@lsgunnlsgunn
Copy link
Contributor Author

@sstraatemans @eileenmguo @realdreamer @isaozler
I'm not 100% sure these setup instructions are correct—This is what I had to do to get the local web server for the docs site running.
Can you take a look and see if you're okay with the changes I'm suggesting?
If there's some additional work I need to do to get this reviewed, please point me in the right direction.
Thanks!

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