Taxonomy/Site structure

Đang mở
  • Có gì không ổn?
#15 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Không có tệp hoặc kiểm thử nào được nêu. Hãy bắt đầu bằng việc xem xét cấu trúc và điều hướng hiện tại của site, sau đó so sánh chúng với taxonomy được đề xuất này; được coi là hoàn tất khi kiến trúc thông tin, hành vi chuyển đổi SLua/LSL và phạm vi ban đầu của Scripting Portal đã được thống nhất.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Here is a proposal for how the site could be structured:

  • Scripting Portal
    • Getting Started
      • Quick introduction for beginners
      • How to create and write scripts
      • Development environment with VS Code Extension
      • Link directly into tutorial in SLua/LSL Language section
    • Features
      • Avatar
      • Communications
      • Combat
      • … and more
    • Guides
      • How to script a Car/Boat, Strategies for dealing with multiple llHTTPRequests, etc. Long form guides/tutorials
    • Recipes
      • How to script a Chair, How to script a Door, llHTTPRequest integration to external API via Vercel proxy, etc. Short, usecase specific step-by-step guides
    • SLua/LSL Language (below is for SLua; Somewhat based on Suzanna’s guide)
      • Getting Started
      • Tutorials
      • SLua vs LSL
      • Types and variables
      • Operators
      • Flow Control: if, while, for, repeat
      • Functions
      • Tables
      • Metatables and metamethods
      • Objects
      • Error handling
      • Libraries
      • Event Handling
      • Timers
      • …?
    • Standard Library (or Scripting Reference)
      • Categories
      • LLEvents
      • LLTimers
      • ll* Functions
      • Luau Libraries
      • Events
      • Constants

The idea is to also have a site-wide toggle (or limited within the Scripting Portal) where the user can switch between SLua and LSL. With something like <If> components in the mdx files to show conditional content, such as for code examples. Likewise the site navigation would also flip based on the toggle, for example the SLua Language menu would flip to LSL Language and show relevant links to how LSL works, like states and stuff. The Standard Library would also be able to flip, for example not showing any of the libraries that are specific to SLua/Luau etc. I'm not sure how to do approach this yet but maybe we could fill the site navigation and then use JS/CSS to update the navigation based on the toggle.

Now you might be wondering why Scripting Portal is at the top, for the SL Create site we should expand it to cover the whole sphere of Content Creation eventually, such as Building, Meshes, Textures, Fashion, Architecture / Level Design, etc. But for now we should focus on Scripting.

Features are high level articles that explain a feature as well as act as a mini-portal by sending the user to a relevant sub article or collating standard library functions, events and constants together for quick access. The Combat2 article on the wiki is a good example of how to do this. Vague on the details above the fold but rich with links for more detailed information.

Guides are long form articles that help you do or understand something. Such as the complexities in scripting an SL vehicle (which can take different creative forms, from the humble Physical Linden Vehicles, Advanced Linden Vehicles with Raycasting, Custom Physics (not using the Linden vehicle functions), Non-Physics (like my mech walker), Wearable Vehicle (pure attachment based vehicles that manipulate avatar movement), …)

Recipes are short, focused how-to guides that walk a reader through completing a working example of a specific task. This should be particularly great for beginners or any scripter that wants to tackle something very specific.

SLua Language/LSL Language will be swapped based on the site-wide SLua/LSL toggle. This contains the tutorials and guides specific to the language itself.

Standard Library (or Scripting Reference or Reference?) would be a reference to all the libraries, functions, events, constants etc.

What do you think? Does this proposal make sense?

Ngôn ngữ chính
MDX
Star
12
Fork
7
Merge trung bình
1 ngày 33 phút
Pull request đã merge (30 ngày)
4

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của secondlife/create

Tất cả issue của secondlife/create

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.