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

Contributing #544

Merged
merged 18 commits into from
Jul 18, 2023
Merged

Contributing #544

merged 18 commits into from
Jul 18, 2023

Conversation

KenCarvAPI
Copy link

Introduction of a 'feedback to API3 docs' page
Review and build of 'contribute to API3 DAO' section

@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2023

Visit the preview URL for this PR (updated for commit 4090d6a):

https://vitepress-docs--pr544-contributing-gmkcdhhb.web.app

(expires Thu, 20 Jul 2023 08:18:24 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: e4c5db1acb62b36273dc03718b86834917dea599

@wkande
Copy link
Member

wkande commented Jul 5, 2023

@KenCarvAPI

You have some heading tags that do not make sense.

  • (Heading1) should only be used once per page at the top of the page: # {{$frontmatter.title}}
  • Heading2 (as many as needed) must be after a (# Heading1). These really separate the page into new subject matter related to (# Heading1)
  • Heading3 can only be nested after a (# Heading2) and are related to the subject matter of the proceeding (## Heading2)

Copy link
Collaborator

@dcroote dcroote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice start- I have several questions and suggestions.

Please also spell check both documents, there are a number of typos.

@wkande - once updated and ready, this PR will need to be squash merged because of the git history

docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/documentation-feedback.md Outdated Show resolved Hide resolved
KenCarvAPI and others added 8 commits July 11, 2023 13:39
Co-authored-by: Derek Croote <dcroote@users.noreply.github.com>
Co-authored-by: Derek Croote <dcroote@users.noreply.github.com>
Co-authored-by: Derek Croote <dcroote@users.noreply.github.com>
Co-authored-by: Derek Croote <dcroote@users.noreply.github.com>
Co-authored-by: Derek Croote <dcroote@users.noreply.github.com>
@KenCarvAPI KenCarvAPI requested a review from dcroote July 11, 2023 13:05
Copy link
Collaborator

@dcroote dcroote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good, only minor changes left

docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/sidebar.js Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/contributing.md Outdated Show resolved Hide resolved
docs/explore/introduction/documentation-feedback.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@dcroote dcroote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

404s need to be fixed, then I think it will be good to go

how to clone, setup, and run the project locally. For non-DAO members a PR from
a fork is always welcome.

You can also see the [Contributing](/docs/explore/introduction/contributing.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

404 currently.

Suggested change
You can also see the [Contributing](/docs/explore/introduction/contributing.md)
You can also see the [Contributing](contributing.md)

Copy link
Member

@wkande wkande Jul 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use: /explore/introduction/contributing.md

See: https://docs.api3.org/dev/hyperlinks.html

### If you are learning about blockchain & oracles

- Read the
[getting started<ExternalLinkImage/>](docs/explore/introduction/index.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

404 currently.

Suggested change
[getting started<ExternalLinkImage/>](docs/explore/introduction/index.md)
[getting started<ExternalLinkImage/>](index.md)

Copy link
Member

@wkande wkande Jul 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use: /explore/introduction/index.md

See: https://docs.api3.org/dev/hyperlinks.html

Also I think the <ExternalLinkImage/> component needs to go.

@wkande
Copy link
Member

wkande commented Jul 18, 2023

I will merge this then pull and fix the links and re-build the indexes.

@wkande wkande merged commit b40dd21 into main Jul 18, 2023
2 checks passed
@wkande wkande deleted the Contributing branch July 18, 2023 11:34
@dcroote
Copy link
Collaborator

dcroote commented Jul 18, 2023

Thanks @wkande

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.

5 participants