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

Update cardano-wallet documentation #4934

Open
abailly opened this issue Jan 10, 2025 · 0 comments
Open

Update cardano-wallet documentation #4934

abailly opened this issue Jan 10, 2025 · 0 comments
Labels
documentation Feature Mark a PR as adding a new feature, for auto-generated CHANGELOG
Milestone
2025Q1

Comments

@abailly
Copy link
Collaborator

abailly commented Jan 10, 2025 •
edited
Loading

The goal is to have an up-to-date and maintained website with all documents related to the design, implementation, process, tools, relevant to the cardano-wallet publicly available and tracked alongside the main codebase.

This includes 2 main efforts:

  • As discussed at the end of 2024, in order to make the cardano-wallet more open-source friendly, we have decided to store all relevant documents alongside the code, in the docs directory, and publish it. This mostly include Advice Process documents but also design documents
  • It's unclear whether the current public-facing documentation under docs/ is up-to-date and relevant. We want to ensure this is the case, removing, updating, adding stuff wherever it's needed
@abailly abailly changed the title Update website with internal public documents Update cardano-wallet website Jan 10, 2025
@abailly abailly added this to the 2025Q1 milestone Jan 10, 2025
@abailly abailly added Feature Mark a PR as adding a new feature, for auto-generated CHANGELOG documentation labels Jan 10, 2025
@abailly abailly mentioned this issue Jan 10, 2025
Merged
@abailly abailly changed the title Update cardano-wallet website Update cardano-wallet documentation Jan 12, 2025
@abailly abailly mentioned this issue Jan 12, 2025
Merged
paolino added a commit that referenced this issue Jan 13, 2025
@paolino
Update README (#4938)
a5dc398 
* Remove or update badges that have become irrelevant following #4899
and #4908
* Move links to documentation at the beginning of the README

#4934
github-merge-queue bot pushed a commit that referenced this issue Feb 3, 2025
@abailly
Document release process in the code base (#4933)
cf000f4 
This PR executes on the decision made on the [3rd of December,
2024](https://docs.google.com/document/d/15bvqKLuVZ6Wp28ZExqRO3YGYi4ILlHGGfJgK2bBBdFU/edit?tab=t.0#heading=h.gjdgxs),
to store documentation alongside code.

* Create a detailed description of the release process in its own page
* Start recording some of the Advice Process decisions in the
documentation for the wallet, under /contributor/decisions tree
* Add release checklist template

#4934
WilliamKingNoel-Bot pushed a commit that referenced this issue Feb 3, 2025
docs: Document release process in the code base (#4933) This PR execu…
7fb3bc5 
…tes on the decision made on the [3rd of December, 2024](https://docs.google.com/document/d/15bvqKLuVZ6Wp28ZExqRO3YGYi4ILlHGGfJgK2bBBdFU/edit?tab=t.0#heading=h.gjdgxs), to store documentation alongside code. CODE-OF-CONDUCT.md CONTRIBUTING.md LICENSE MAINTAINERS.md README.md cabal.project configs docker-compose.yml docs flake.lock flake.nix floskell.json fourmolu.yaml hie-direnv.yaml justfile lib nix prototypes reports run scripts specifications test touch.me.CI weeder.dhall Create a detailed description of the release process in its own page CODE-OF-CONDUCT.md CONTRIBUTING.md LICENSE MAINTAINERS.md README.md cabal.project configs docker-compose.yml docs flake.lock flake.nix floskell.json fourmolu.yaml hie-direnv.yaml justfile lib nix prototypes reports run scripts specifications test touch.me.CI weeder.dhall Start recording some of the Advice Process decisions in the documentation for the wallet, under /contributor/decisions tree CODE-OF-CONDUCT.md CONTRIBUTING.md LICENSE MAINTAINERS.md README.md cabal.project configs docker-compose.yml docs flake.lock flake.nix floskell.json fourmolu.yaml hie-direnv.yaml justfile lib nix prototypes reports run scripts specifications test touch.me.CI weeder.dhall Add release checklist template #4934 Source commit: cf000f4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Feature Mark a PR as adding a new feature, for auto-generated CHANGELOG
Projects
None yet
Milestone
2025Q1
Development

No branches or pull requests
1 participant
@abailly