Skip to content

Publish style guide like other products #551

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

Open
mjang opened this issue May 14, 2025 · 2 comments
Open

Publish style guide like other products #551

mjang opened this issue May 14, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@mjang
Copy link
Contributor

mjang commented May 14, 2025

Overview

As a writer, I want easy access to the NGINX style guide, so I can:

  • Refer to it as needed
  • include instructions / links from it for others, without having to refer to the GitHub repo

Description

It's difficult for many to access the GitHub repo for style. In addition, published style guides have more credibility.

Acceptance criteria

A style guide accessible at a docs.nginx.com URL such as docs.nginx.com/style-guide

@mjang mjang added the documentation Improvements or additions to documentation label May 14, 2025
@mjang
Copy link
Contributor Author

mjang commented May 14, 2025

cc @ADubhlaoich . @jputrino suggested that you also want this. It would have made my life easier during Write the Docs writing day

@ADubhlaoich
Copy link
Contributor

In a much broader sense, I actually want the entirety of our process documentation public as a unified contribution hub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants