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

Content - long-form #371

Closed
3 tasks done
Tracked by #348
RobTobias123 opened this issue Feb 7, 2024 · 10 comments
Closed
3 tasks done
Tracked by #348

Content - long-form #371

RobTobias123 opened this issue Feb 7, 2024 · 10 comments
Assignees
Labels
Status: Completed Nothing further to be done with this issue. Awaiting to be closed Type: Documentation Improvements or additions to documentation

Comments

@RobTobias123
Copy link
Contributor

RobTobias123 commented Feb 7, 2024

Outcome

A clear definition of what log-form content pages should exist outside of the 'components template', where they live and what content should be on them.

Scope

  • Take the existing docs Getting Started, Foundations, and Community pages as a starting point to work out where the content belongs. (eg. we may want to remove 'Modular Scale')

  • Analyse content structure

  • Describe each in the comments in this ticket and suggest content arrangement using these labels as directives:

    • Remove
    • Move to Internal docs
    • Move to...
    • Replicate
    • Adjust
@RobTobias123 RobTobias123 added the Type: Documentation Improvements or additions to documentation label Feb 7, 2024
@RobTobias123 RobTobias123 added this to the Internal tools milestone Feb 7, 2024
@RobTobias123 RobTobias123 self-assigned this Feb 7, 2024
@RobTobias123
Copy link
Contributor Author

Analysing existing docs content and identifying content to retain and suggested locations.

Figma WIP: https://www.figma.com/file/8SAEjYluT2tYwSPBFHmtjO/371---Content---Long-form?type=design&node-id=0%3A1&mode=design&t=EftvQtEflpI5z2f1-1

@RobTobias123
Copy link
Contributor Author

Getting Started pages content considered to where it belongs - here with my comments in line (in red/pink etc): https://www.figma.com/file/8SAEjYluT2tYwSPBFHmtjO/371---Content---Long-form?type=design&node-id=1%3A13&mode=design&t=EftvQtEflpI5z2f1-1

Some of this content I have suggested using on the home page, some in a page that doesn't exist yet 'About Nucleus' as too detailed for home page but I don't think it should be left out from the New docs as important. Let me know what you think.

@RobTobias123
Copy link
Contributor Author

Foundations pages content considered to where it belongs - here with my comments in line (in red/pink etc): https://www.figma.com/file/8SAEjYluT2tYwSPBFHmtjO/371---Content---Long-form?type=design&node-id=11%3A97&mode=design&t=EftvQtEflpI5z2f1-1

@RobTobias123 RobTobias123 added the Status: Review Needed The issue has a PR attached to it which needs to be reviewed label Feb 19, 2024
@RobTobias123
Copy link
Contributor Author

Community pages content analysed and considered to where it belongs - here with my comments in line (in red/pink etc):

https://www.figma.com/file/8SAEjYluT2tYwSPBFHmtjO/371---Content---Long-form?type=design&node-id=0%3A1&mode=design&t=EftvQtEflpI5z2f1-1

@RobTobias123
Copy link
Contributor Author

Set up a branch from astro docs called feature/long-form-content-populate where I will be adding the proposed content.

@RobTobias123
Copy link
Contributor Author

Following yesterday evening's review and feedback session it was agreed that the content suggestions were appropriate and I will be adding/editing on the long-form content pages.

@RobTobias123 RobTobias123 added Status: Completed Nothing further to be done with this issue. Awaiting to be closed and removed Status: Review Needed The issue has a PR attached to it which needs to be reviewed labels Feb 20, 2024
@RobTobias123
Copy link
Contributor Author

RobTobias123 commented Feb 21, 2024

Multiple pages of content have been added/edited and reconfigured and SVGs created and provided. Reviewed with team. PR for review/approal #408

Including Guidelines pages:

  • Created About page (Nucleus principles)
  • Updates to Tokens page
  • Assets page additional content and merge with placeholder
  • Devices page for viewports and browser info
  • Typography page (weights, semanatic vs styles)
  • All the SVGs for new page names created and added.
  • plus more...

@RobTobias123
Copy link
Contributor Author

Following feedback today - looking into adding a Principles area to Guidelines.

@RobTobias123
Copy link
Contributor Author

PR for review - adding principles to guidelines area and moving about us renamed as introduction to outside the containers. Further additions to the Guidelines will be made on this PR such as Accessibility as it is understood. #421

@RobTobias123
Copy link
Contributor Author

approved and merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Completed Nothing further to be done with this issue. Awaiting to be closed Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant