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

fix(docs): use constants file for urls everywhere in docs #4443

Merged
merged 11 commits into from
Dec 23, 2024
Merged

fix(docs): use constants file for urls everywhere in docs #4443

merged 11 commits into from
Dec 23, 2024

Conversation

vivekjain23
Copy link
Contributor

Description of change

This PR brings up the changes to usage of constant file for URLs everywhere in docs.

Links to any relevant issues

fixes #4106

Type of change

Choose a type of change, and delete any options that are not relevant.

  • Enhancement (a non-breaking change which adds functionality)

How the change has been tested

Changes were built locally.

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes

@vivekjain23 vivekjain23 added documentation Improvements or additions to documentation dx-documentation For TW or documentation related issues. devx Issues related to the DevX team labels Dec 11, 2024
@vivekjain23 vivekjain23 marked this pull request as ready for review December 12, 2024 06:35
@vivekjain23 vivekjain23 requested a review from a team as a code owner December 12, 2024 06:35
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Dr-Electron
Dr-Electron requested changes Dec 13, 2024
View reviewed changes
Copy link
Contributor

@Dr-Electron Dr-Electron left a comment

Choose a reason for hiding this comment

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

Lovely PR, this will really help keeping everything consistent.

Maybe we should add the constant import to the MDXComponent so we don't have to import it all the time?

Also should we explain how people can use this constants in the contribution guide?

docs/content/developer/getting-started/get-coins.mdx Outdated Show resolved Hide resolved
docs/content/developer/getting-started/get-coins.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/custom-indexer.mdx Outdated Show resolved Hide resolved
docs/content/operator/iota-full-node/source.mdx Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@vivekjain23
Copy link
Contributor Author

Lovely PR, this will really help keeping everything consistent.

Maybe we should add the constant import to the MDXComponent so we don't have to import it all the time?

Also should we explain how people can use this constants in the contribution guide?

Adding them to MDXComponent could be a good idea, should I go for it in this PR?

@Dr-Electron
Copy link
Contributor

Lovely PR, this will really help keeping everything consistent.
Maybe we should add the constant import to the MDXComponent so we don't have to import it all the time?
Also should we explain how people can use this constants in the contribution guide?

Adding them to MDXComponent could be a good idea, should I go for it in this PR?

Yeah let's add it. I think that makes sense and is related to this change 👍

Dr-Electron
Dr-Electron previously requested changes Dec 20, 2024
View reviewed changes
Copy link
Contributor

@Dr-Electron Dr-Electron left a comment

Choose a reason for hiding this comment

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

Commented on some of my old suggestions. I would add back the const for faucet and use CodeBlocks in that once place. Other than that I think we can merge afterwards

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@vivekjain23 vivekjain23 dismissed Dr-Electron’s stale review December 23, 2024 11:45

Changes have been implemented.

@vivekjain23 vivekjain23 merged commit 385e36a into develop Dec 23, 2024
36 checks passed
@vivekjain23 vivekjain23 deleted the devx/constants-file-for-urls branch December 23, 2024 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucas-tortora lucas-tortora lucas-tortora approved these changes

@Ginowine Ginowine Ginowine approved these changes

@Dr-Electron Dr-Electron Dr-Electron left review comments

Assignees
No one assigned
Labels
devx Issues related to the DevX team documentation Improvements or additions to documentation dx-documentation For TW or documentation related issues.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use constants file for urls everywhere in docs
4 participants
@vivekjain23 @Dr-Electron @Ginowine @lucas-tortora