Skip to content

Refine user documentation.#24

Merged
jglogan merged 2 commits intomainfrom
readme-rework
Jun 6, 2025
Merged

Refine user documentation.#24
jglogan merged 2 commits intomainfrom
readme-rework

Conversation

@jglogan
Copy link
Contributor

@jglogan jglogan commented Jun 6, 2025

  • Extract README sections into BUILDING and CONTRIBUTING documents. This should work better than sections in README as it keeps the README short, and the BUILDING and CONTRIBUTING files will stand out in the file list.
  • Merged localdev document into BUILDING.
  • Fixed broken links.
  • Changed DNS setup so later DNS-dependent steps should work.
  • Added h1 and link to SECURITY document.

README.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Is moving this bellow the gif intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yep, sort of an A/B test, we'll see what folks like better

Copy link
Contributor

@egernst egernst left a comment

Choose a reason for hiding this comment

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

This looks good - similar question from what Aditya left on whether you want Container heading before or after gif. Thanks.

- Extract README sections into BUILDING and CONTRIBUTING documents.
  This should work better than sections in README as it keeps the
  README short, and the BUILDING and CONTRIBUTING files will
  stand out in the file list.
- Merged localdev document into BUILDING.
- Fixed broken links.
- Changed DNS setup so later DNS-dependent steps should work.
- Added h1 and link to SECURITY document.
@jglogan jglogan merged commit 94e06e2 into main Jun 6, 2025
1 of 2 checks passed
@jglogan jglogan deleted the readme-rework branch June 6, 2025 01:50
owenarthur pushed a commit to owenarthur/container that referenced this pull request Jun 10, 2025
- Extract README sections into BUILDING and CONTRIBUTING documents. This
should work better than sections in README as it keeps the README short,
and the BUILDING and CONTRIBUTING files will stand out in the file list.
- Merged localdev document into BUILDING.
- Fixed broken links.
- Changed DNS setup so later DNS-dependent steps should work.
- Added h1 and link to SECURITY document.
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.

4 participants