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

rfc: wing documentation v2 #6793

Merged
merged 8 commits into from
Aug 28, 2024
Merged

rfc: wing documentation v2 #6793

merged 8 commits into from
Aug 28, 2024

Conversation

boyney123
Copy link
Contributor

@boyney123 boyney123 commented Jun 26, 2024

RFC for documentation v2.

Rendered document

By submitting this pull request, I confirm that my contribution is made under the terms of the Wing Cloud Contribution License.

David Boyne added 2 commits June 26, 2024 14:08
@boyney123 boyney123 requested a review from a team as a code owner June 26, 2024 13:15
Copy link

Thanks for opening this pull request! 🎉
Please consult the contributing guidelines for details on how to contribute to this project.
If you need any assistance, don't hesitate to ping the relevant owner over Discord.

Topic Owner
Wing SDK and utility APIs @chriscbr
Wing Console @ainvoner, @skyrpex, @polamoros
JSON, structs, primitives and collections @hasanaburayyan
Platforms and plugins @hasanaburayyan
Frontend resources (website, react, etc) @tsuf239
Language design @chriscbr
VSCode extension and language server @markmcculloh
Compiler architecture, inflights, lifting @yoav-steinberg
Wing Testing Framework @tsuf239
Wing CLI @markmcculloh
Build system, dev environment, releases @markmcculloh
Library Ecosystem @chriscbr
Documentation @hasanaburayyan
SDK test suite @tsuf239
Examples @hasanaburayyan
Wing Playground @eladcon

@boyney123 boyney123 changed the title rfc: Wing documentation v2 rfc: wing documentation v2 Jun 26, 2024
Copy link
Contributor

@hasanaburayyan hasanaburayyan left a comment

Choose a reason for hiding this comment

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

Im sooo excited for this

docs/contributing/999-rfcs/2024-06-26-wing-docs-v2.md Outdated Show resolved Hide resolved
docs/contributing/999-rfcs/2024-06-26-wing-docs-v2.md Outdated Show resolved Hide resolved
docs/contributing/999-rfcs/2024-06-26-wing-docs-v2.md Outdated Show resolved Hide resolved
@hasanaburayyan hasanaburayyan requested a review from a team June 26, 2024 21:58
@NathanTarbert
Copy link
Collaborator

I'm super excited about this!
The sitemap looks great!

mergify bot pushed a commit to winglang/docsite that referenced this pull request Jul 8, 2024
A WIP pull request, to start to demo the [documentation v2 RFC](winglang/wing#6793) and fixed winglang/wing#6829

This PR mainly focuses on moving pages into the new section (API), or and rearranging pages we already have into relevant sub folders. Next phase will be adding new content and further refactorings.

See the changes here in [the preview environment](https://wing-docs-git-api-section-monada.vercel.app/docs/why-wing)

## List of changes

#### Navigation changes
- New **Learn** heading in nav bar (previously docs)
- New **API** heading in nav bar
- New **Examples** heading in nav bar (will be examples/patterns custom page in the future)

#### API Section
- Moved [CLI User Manual](https://www.winglang.io/docs/tools/cli) from docs sections to API
- Renamed and moved [Examples](https://www.winglang.io/docs/category/examples) to **Wing Language** from docs section to API
- Moved [Standard Library](https://www.winglang.io/docs/category/standard-library) from docs section to API
- Moved [Language Reference](https://www.winglang.io/docs/language-reference) from docs section to API
- Moved [Analytics](https://www.winglang.io/docs/analytics) from docs section to API

#### Learn Section (previously docs)
- Renamed and moved [Why Wing](https://www.winglang.io/docs/concepts/why-wing) to **What is Wing?** to the top of the learn section.
- Moved and added new subfolders to [Platforms](https://www.winglang.io/docs/category/platforms) to under **core concepts**.
   - New **What are platforms** page added (previously https://www.winglang.io/docs/concepts/platforms)
   - New **AWS** subfolder added
   - New **Google Cloud** subfolder added
   - New **Microsoft Azure** subfolder added
- Renamed and added new sections for [Libraries](https://www.winglang.io/docs/libraries), renamed to **Wing Libraries (winglibs)**
  - Split [previous page](https://www.winglang.io/docs/libraries) into three new pages.
     - What are winglibs? 
     - Importing winglibs  
     - Creating winglibs
     
- Tools, Guides, TypeScript and FAQ sections untouched (apart from CLI guide moving from tools)
 
#### Other notes
  - Added redirects for pages to their new urls.

#### TODO
 - Add redirects for Standard Library
 - Replace urls in the docssite for anything that has moved (don't force folks to redirect unless we miss something).
 - Make changes into the main docs repo once this PR has been reviewed and the direction of docs has been approved.
 - Update webflow for winglang.io with nav changes.
@boyney123
Copy link
Contributor Author

Update,

  • Docusuarus v3 and packages updated (phase 1 done)
  • Introducing new API section and organising pages (phase 2 done and live on doc website)

Copy link

Hi,

This PR has not seen activity in 20 days. Therefore, we are marking the PR as stale for now. It will be closed after 7 days.
If you need help with the PR, do not hesitate to reach out in the winglang community Discord.
Feel free to re-open this PR when it is still relevant and ready to be worked on again.
Thanks!

@github-actions github-actions bot added the Stale label Jul 30, 2024
@Chriscbr Chriscbr removed the Stale label Jul 31, 2024
@boyney123
Copy link
Contributor Author

Update

Copy link

Hi,

This PR has not seen activity in 20 days. Therefore, we are marking the PR as stale for now. It will be closed after 7 days.
If you need help with the PR, do not hesitate to reach out in the winglang community Discord.
Feel free to re-open this PR when it is still relevant and ready to be worked on again.
Thanks!

@github-actions github-actions bot added the Stale label Aug 27, 2024
@boyney123 boyney123 removed the Stale label Aug 27, 2024
Copy link
Contributor

@Chriscbr Chriscbr left a comment

Choose a reason for hiding this comment

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

Let's merge this in :)

@boyney123 boyney123 merged commit f773d4a into main Aug 28, 2024
12 checks passed
@boyney123 boyney123 deleted the documentation-v2-rfc branch August 28, 2024 08:51
Copy link
Contributor

mergify bot commented Aug 28, 2024

Thanks for contributing, @boyney123! This PR will now be added to the merge queue, or immediately merged if documentation-v2-rfc is up-to-date with main and the queue is empty.

mergify bot added a commit that referenced this pull request Aug 28, 2024
@monadabot
Copy link
Contributor

Congrats! 🚀 This was released in Wing 0.83.7.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants