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

Restructure documentation into three main sections #4040

Merged

Conversation

HeinrichApfelmus
Copy link
Contributor

This pull request restructures the documentation into three main sections:

  • User manual — what the user is supposed to see when looking at the wallet
  • Design — what the developer sees when looking at the wallet
  • Contributor manual — what the developer sees when looking at the tools and processes that are used to build the wallet, but that are not specific to the problem domain of "wallet"

Copy link
Member

@jonathanknowles jonathanknowles left a comment

Choose a reason for hiding this comment

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

Hi @HeinrichApfelmus

I've had a look at this, and it seems fine, though I'd like to double-check some things with you! Perhaps we can have a very quick call at a time that is convenient for you? 🙏🏻

(I've also left a few suggestions and corrections.)

docs/site/src/design.md Outdated Show resolved Hide resolved
docs/site/src/contributor.md Outdated Show resolved Hide resolved
docs/site/src/contributor/how/continuous-integration.md Outdated Show resolved Hide resolved
@HeinrichApfelmus HeinrichApfelmus force-pushed the HeinrichApfelmus/quick-documentation-structure branch from dc11893 to 3a6151a Compare July 21, 2023 14:23
Copy link
Member

@jonathanknowles jonathanknowles left a comment

Choose a reason for hiding this comment

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

LGTM!

@HeinrichApfelmus HeinrichApfelmus added this pull request to the merge queue Jul 25, 2023
Merged via the queue into master with commit 66fb847 Jul 25, 2023
2 checks passed
@HeinrichApfelmus HeinrichApfelmus deleted the HeinrichApfelmus/quick-documentation-structure branch July 25, 2023 08:13
WilliamKingNoel-Bot pushed a commit that referenced this pull request Jul 25, 2023
… pull request restructures the documentation into three main sections: CODE-OF-CONDUCT.md CONTRIBUTING.md LICENSE MAINTAINERS.md README.md bors.toml cabal.project default.nix docker-compose.yml docs flake.lock flake.nix floskell.json fourmolu.yaml hie-direnv.yaml lib nix prototypes reports scripts shell.nix specifications test touch.me.CI weeder.dhall User manual — what the user is supposed to see when looking at the wallet CODE-OF-CONDUCT.md CONTRIBUTING.md LICENSE MAINTAINERS.md README.md bors.toml cabal.project default.nix docker-compose.yml docs flake.lock flake.nix floskell.json fourmolu.yaml hie-direnv.yaml lib nix prototypes reports scripts shell.nix specifications test touch.me.CI weeder.dhall Design — what the developer sees when looking at the wallet CODE-OF-CONDUCT.md CONTRIBUTING.md LICENSE MAINTAINERS.md README.md bors.toml cabal.project default.nix docker-compose.yml docs flake.lock flake.nix floskell.json fourmolu.yaml hie-direnv.yaml lib nix prototypes reports scripts shell.nix specifications test touch.me.CI weeder.dhall Contributor manual — what the developer sees when looking at the tools and processes that are used to build the wallet, but that are not specific to the problem domain of "wallet" Source commit: 66fb847
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