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

Revamp Internal Horizon Documentation #4948

Merged
merged 24 commits into from
Aug 10, 2023

Conversation

aditya1702
Copy link
Contributor

@aditya1702 aditya1702 commented Jul 7, 2023

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

Closes #4936 and #4939

This PR rearranges and adds internal documentation:

  • Creating an updated development guide that is easier to understand.
  • Adding a new readme on Horizon SDK and API.
  • Adding references to all these files on the main README page for easier access.

Why

There was a lot of redundant readme files and documentation that made it harder for someone new in the team to understand the codebase. These changes remove the duplicate documentation, adds some new READMEs and brings all important resources under a single roof.

Known limitations

None.

@aditya1702 aditya1702 self-assigned this Jul 7, 2023
@aditya1702 aditya1702 changed the title Revamp internal Horizon documentation Revamp Internal Horizon Documentation Jul 7, 2023
@aditya1702 aditya1702 linked an issue Jul 7, 2023 that may be closed by this pull request
@aditya1702 aditya1702 linked an issue Jul 10, 2023 that may be closed by this pull request
@aditya1702 aditya1702 requested a review from sreuland July 31, 2023 20:04
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sreuland sreuland left a comment

Choose a reason for hiding this comment

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

the new consolidated content looks good, thanks for addressing all the feedback, I left a few additional suggestions on minor tweaks.

@aditya1702 aditya1702 merged commit 9c94bc5 into stellar:master Aug 10, 2023
24 checks passed
@aditya1702 aditya1702 deleted the setup-dev-env branch August 18, 2023 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Horizon development guide services/horizon: Update README docs for installation types
4 participants