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

Documentation #49

Merged
merged 9 commits into from
Dec 11, 2023
Merged

Documentation #49

merged 9 commits into from
Dec 11, 2023

Conversation

dnut
Copy link
Contributor

@dnut dnut commented Dec 4, 2023

Addresses #43

Added docs to explain how to get up and running with Sig.

  • Added new content to readme.md:
    • Links to blog posts and other docs in the repo
    • Setting up a development environment
    • Building Sig
    • Running Sig: subcommands (e.g. gossip) and CLI options
    • Running the tests and benchmarks
  • Moved API documentation into docs/api.md and linked to it from the "Import Sig" section of the readme.
  • Fixed incorrect license and zig version icons in the readme header
  • Fixed inconsistent sig version in build.zig.zon (to be consistent with cmd.zig)

See the updated readme in a realistic looking context: https://github.com/dnut/sig/tree/docs-improvements

Review Prompts:

  1. Should we just publish the readme to github.io as is, or should we create another page to publish there?
  2. Do the section structure and section headings make sense?
  3. Should I move any content from the readme to CONTRIBUTING.md? For example, environment setup or running tests. I feel it is more discoverable in the readme.
  4. Should I change the header of the readme, for example adding a logo?

@dnut dnut linked an issue Dec 4, 2023 that may be closed by this pull request
@dnut dnut marked this pull request as ready for review December 4, 2023 22:15
readme.md Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
0xNineteen
0xNineteen previously approved these changes Dec 5, 2023
ultd
ultd previously approved these changes Dec 11, 2023
@dnut dnut dismissed stale reviews from ultd and 0xNineteen via 10873b9 December 11, 2023 22:26
@ultd ultd merged commit 4f4af09 into Syndica:main Dec 11, 2023
2 checks passed
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.

Contributing missing basic details
3 participants