Skip to content

Simonletort da/1034 from the docs site, users do not know how they can suggest changes to the docs #1036

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

Draft
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

simonletort-da
Copy link
Contributor

Pull Request Checklist

Cluster Testing

  • If a cluster test is required, comment /cluster_test on this PR to request it, and ping someone with access to the DA-internal system to approve it.
  • If a hard-migration test is required (from the latest release), comment /hdm_test on this PR to request it, and ping someone with access to the DA-internal system to approve it.

PR Guidelines

  • Include any change that might be observable by our partners or affect their deployment in the release notes.
  • Specify fixed issues with Fixes #n, and mention issues worked on using #n
  • Include a screenshot for frontend-related PRs - see README or use your favorite screenshot tool

Merge Guidelines

  • Make the git commit message look sensible when squash-merging on GitHub (most likely: just copy your PR description).

@simonletort-da
Copy link
Contributor Author

fixes #1034

…ow-how-they-can-suggest-changes-to-the-docs' of https://github.com/simonletort-da/splice into simonletort-da/1034-From-the-docs-site,-users-do-not-know-how-they-can-suggest-changes-to-the-docs
@@ -0,0 +1,3 @@
{
"image": "ghcr.io/zombiezen/codespaces-nix"
Copy link
Contributor

@ray-roestenburg-da ray-roestenburg-da Jun 12, 2025

Choose a reason for hiding this comment

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

Was this intended to be part of the PR, or maybe a local leftover? (I think it should not be part of the PR)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was trying to get nix to run in GH Codespace. But it's not working. This is why I kept the PR as 'draft'

Copy link
Contributor

Choose a reason for hiding this comment

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

ok thanks

Copy link
Contributor

@ray-roestenburg-da ray-roestenburg-da left a comment

Choose a reason for hiding this comment

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

Would remove the devcontainer file, otherwise looks good, thanks

@simonletort-da
Copy link
Contributor Author

@ray-roestenburg-da I was trying to get nix to run on GH Codespace, but I haven't been able to make it work.
I'm also getting issue on my local machine to run nix.
Overall, I personally find it too difficult for non engineering experts to be able to generate a preview of the doc.
I'd like to try finding a way to simplify that, maybe just providing a sphynx script to build the doc without all the nix / direnv requirements.
This is why I was keeping this PR as draft.

@simonletort-da
Copy link
Contributor Author

simonletort-da commented Jun 16, 2025

@ethancohen-da you can get inspired by this script" https://github.com/DACH-NY/canton-utility-examples/blob/main/scripts/preview-docs.sh

Instructions:

@ethancohen-da
Copy link

@simonletort-da please review changes made to delpoyment.rst

simonletort-da and others added 5 commits June 18, 2025 17:02
…ow-how-they-can-suggest-changes-to-the-docs' into 731-Document-high-level-roles-and-functions-of-the-nodes-making-up-the-CN
…es-and-functions-of-the-nodes-making-up-the-CN

bringing 731 changes to 1034
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants