Replies: 5 comments 4 replies
-
|
Solid architecture and should be focused. But it should be desinged in such a way that it should not be strict with BLT, but any could use it for their starting guide. Open source community is dealing with problem from a while now, on-boardung a new contributor to their project. Addional opinion:
could be a potential idea for gsoc. |
Beta Was this translation helpful? Give feedback.
-
|
I think L2 and I might not be necessary as standalone projects. We can keep onboarding simple and clean with well-structured documentation, which we already largely have. If something is unclear or needs improvement, that’s the beauty of an OSS project contributors are welcome to raise a PR and improve it. |
Beta Was this translation helpful? Give feedback.
-
|
Appreciate the review and suggestions! But just to clarify, the main idea is an AI guide with a lightweight, optional UI walkthrough for first-time visitors/users/contributors. Something similar to (click on live demo) https://introjs.com/ where users can click “New to BLT? Start Here” and see short explanations different section like - Issues, Check-In, BACON, Bounties, Staking, Domains, etc. this can help reduce initial confusion when someone lands on BLT page and sees may features at once. The AI guide would act as a supporting layer, mainly to explain security concepts in simple terms, clarify jargon, and pointing users to relevant docs when needed. It won't review code or replace existing tools like CR, instead help reduce repetitive questions for maintainers and first-time contributors. Would love to discuss this further and refine it wherever needed based on community feedback. I hope I understood your points correctly. @mdkaifansari04 @Nachiket-Roy |
Beta Was this translation helpful? Give feedback.
-
|
I think this project is a really good idea since BLT is confusing for a first timer, but yes I think maybe we should wait until core systems are properly in place. And yes, we can't decide about other OSS projects. |
Beta Was this translation helpful? Give feedback.
-
|
yeah, makes sense!! so based on discussion, we could start by treating AI guide as the core work and the UI walkthrough could be added on at a later stage. Regarding structure, I agree we shouldn’t design this assuming reuse across other OSS projects so definitely the primary goal remains BLT. However, if designed cleanly, parts of the AI guide’s structure could be made configurable (via data/config files). That way, BLT keeps a constrained version tailored to its needs, and if ever useful, a more general version could optionally be open-sourced for reuse by simply changing links/content sources. But that would simply be a by-product of good design, not the main objective. If it feels unnecessary, we can drop that idea entirely. This is just an idea if we are considering anything for other projects. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Idea I — First-Time Contributor Experience & AI-Assisted Security Guide
Idea Type: Single 350-hour development effort
One line: Security-first onboarding, documentation clarity, and an AI-assisted guide to help contributors understand BLT and OWASP expectations before contributing.
Description:
Improves BLT’s first-time contributor experience by addressing onboarding, navigation, and documentation gaps that lead to insecure or low-quality contributions. The idea introduces a clear
“start here” walkthrough for new users, security-focused information architecture, and contribution clarity pages that explain what qualifies as a security contribution and why PRs may be rejected.
Includes a constrained, explain-only AI Security Guide embedded into the website that answers contributor questions in beginner-friendly language using BLT documentation, GitHub Discussions,
and OWASP public resources (e.g. OWASP Top 10, Cheat Sheet Series). The AI does not review code, analyze diffs, approve PRs, or generate exploit guidance; it is strictly scoped to explanation,
clarification, and linking to authoritative sources.
Problem Statement
Current challenges observed in BLT onboarding and contribution flow:
Solution: BLT First-Time Contributor Experience & Security Guide
A UI/UX-first onboarding and learning system, supported by a constrained, explain-only AI guide, designed to educate contributors before mistakes happen.
The solution focuses on clarity, guidance, and learning, not automation or enforcement.
Key components:
1 First-time user walkthrough (“New to BLT? Start Here”) explaining BLT’s security focus, contribution flow, common beginner mistakes, and next steps
What BLT is and why it is security-focused
How a secure contribution works end-to-end (issue → fix → review → learning)
What counts as a security contribution (with concrete examples)
Common beginner mistakes (including AI copy-paste issues)
Where contributors should go next (correct docs, repos, beginner-friendly issues)
This reduces confusion and prevents insecure contributions before they are submitted.
2 Security-focused navigation and page annotations to distinguish beginner paths from advanced tools and apps
Groups security-critical sections clearly and visibly Adds short “why this matters” explanations to major areas Distinguishes beginner paths
from advanced tools and apps This makes BLT’s security-first nature immediately obvious.
Learn & Understand: Pages that explain how security works in BLT (Documentation, “New to BLT? Start Here”, AI Security Guide,...)
Contribute & Collaborate: Pages related to working with others (Projects, Repositories, GitHub links, Teams,...)
Advanced / Platform Tools: Pages that are not for beginners (SimilarityScan, Time Logs, Check-In, Staking, BACON, Admin / stats tools
3 Documentation surfacing and fixes (repair broken links, define canonical entry points)
Fixes broken documentation links and defines canonical entry points
Adds clarity pages such as:
“What counts as a security contribution?”
“Why PRs get rejected at BLT”
Uses plain, beginner-friendly language and anonymized real examples to explain security expectations
This turns rejections into learning, not frustration.
4 Embedded AI Security Guide for contextual, beginner-friendly explanations grounded in BLT + OWASP content
An embedded, context-aware AI Security Guide that acts as a smart help layer, not a general chatbot.
What it does:
Answers contributor questions in beginner-friendly language
Explains OWASP concepts and BLT contribution rules
Points users to relevant BLT docs, GitHub Discussions, and OWASP resources
What it does NOT do:
Review code or analyze diffs
Approve or reject PRs
Generate exploit guidance or security fixes
The AI is grounded only in:
BLT documentation and contribution guidelines
BLT GitHub Discussions
Well-established OWASP resources (e.g., OWASP Top 10, Cheat Sheet Series)
All responses are source-linked and auditable.
Scope notes
Impact:
Fewer insecure or misunderstood PRs
Better first-time contributor experience
Reduced reviewer burden
Stronger alignment with OWASP’s secure-by-design and education mission
Why this matters now
As AI-assisted coding becomes common, understanding why something is insecure is more important than ever. This idea ensures BLT remains a place where contributors learn security — not just ship code and aligns well with BLT's goals for 2026.
Beta Was this translation helpful? Give feedback.
All reactions