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

[ISSUE][DOCS] Split contributor guide into multiple topics #562

Closed
sptramer opened this issue Jun 17, 2021 · 0 comments
Closed

[ISSUE][DOCS] Split contributor guide into multiple topics #562

sptramer opened this issue Jun 17, 2021 · 0 comments
Assignees
@sptramer
Labels
kind/enhancement Enhancement to an existing feature

Comments

@sptramer
Copy link
Contributor

Describe the issue

The style guide is too huge and hard to navigate!

Impacted page(s)

https://docs.o3de.org/docs/contributing/to-docs/style-guide/

Expected experience

The style guide is split up by general topic type - each H2 could easily be its own page right now, and it's also not clear from this page which guidance is didactic (required behavior) and which is advisory (guidelines to keep in mind when writing).
@sptramer sptramer added kind/enhancement Enhancement to an existing feature sig-review labels Jun 17, 2021
@sptramer sptramer self-assigned this Jun 17, 2021
@sptramer sptramer mentioned this issue Jun 23, 2021
Closed
3 tasks
@paucom paucom closed this as completed in a4a4b60 Jun 29, 2021
paucom added a commit that referenced this issue Jun 29, 2021
@paucom
Merge pull request #586 from sptramer/split-style-guide
e6192ed 
Split style guide into multiple sections to make it easier to navigate. [RESOLVES #562]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sptramer sptramer

Labels
kind/enhancement Enhancement to an existing feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sptramer