Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# EditorConfig keeps formatting consistent across editors.
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Bug Report
description: Report a repository, workflow, or documentation defect.
title: "Bug: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thank you for helping improve the NTARI Developer Portal. Please provide enough detail for maintainers to reproduce or verify the issue.
- type: textarea
id: problem
attributes:
label: Problem
description: What is broken or behaving unexpectedly?
placeholder: Describe the issue clearly.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What should happen instead?
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Provide steps, links, file paths, or screenshots when relevant.
placeholder: |
1. Go to ...
2. Open ...
3. Observe ...
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any other relevant details.
validations:
required: false
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Documentation Improvement
description: Request a clarification, correction, or future documentation topic.
title: "Docs: "
labels:
- documentation
body:
- type: textarea
id: location
attributes:
label: Documentation Location
description: Link the page, file, heading, or proposed location.
placeholder: docs/engineering-handbook/...
validations:
required: false
- type: textarea
id: improvement
attributes:
label: Requested Improvement
description: What should be clarified, corrected, or added?
validations:
required: true
- type: textarea
id: rationale
attributes:
label: Rationale
description: Why is this change useful or necessary?
validations:
required: true
- type: textarea
id: notes
attributes:
label: Additional Notes
description: Add references, examples, or related discussions.
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/engineering_rfc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Engineering RFC
description: Propose a significant engineering process, architecture, or governance decision.
title: "RFC: "
labels:
- rfc
body:
- type: textarea
id: summary
attributes:
label: Summary
description: Provide a concise overview of the proposal.
validations:
required: true
- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem or opportunity does this RFC address?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposal
description: Describe the proposed decision, process, or standard.
validations:
required: true
- type: textarea
id: impact
attributes:
label: Impact
description: Who or what would be affected by this proposal?
validations:
required: true
- type: textarea
id: open_questions
attributes:
label: Open Questions
description: List unresolved questions, risks, or decisions needed.
validations:
required: false
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Feature Request
description: Suggest a repository capability, workflow, or documentation enhancement.
title: "Feature: "
labels:
- enhancement
body:
- type: textarea
id: summary
attributes:
label: Summary
description: What capability or improvement are you proposing?
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: Why would this be valuable for NTARI maintainers or contributors?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed Approach
description: Describe the expected behavior, workflow, or implementation direction.
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: List alternatives or tradeoffs if applicable.
validations:
required: false
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Summary

Check failure on line 1 in .github/PULL_REQUEST_TEMPLATE.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

First line in a file should be a top-level heading

.github/PULL_REQUEST_TEMPLATE.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Summary"] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md041.md

<!-- Describe the purpose of this pull request in a few sentences. -->

## Type of Change

- [ ] Documentation update
- [ ] Repository configuration
- [ ] Governance or process update
- [ ] Engineering RFC
- [ ] Other maintenance

## Related Issues or RFCs

<!-- Link related issues, discussions, or RFCs. Use "None" if not applicable. -->

## Review Checklist

- [ ] The change is scoped and reviewable.
- [ ] Markdown renders correctly on GitHub.
- [ ] Links are valid or intentionally pending.
- [ ] Spelling and terminology have been reviewed.
- [ ] No confidential, private, or security-sensitive information is included.

## Additional Notes

<!-- Add reviewer context, follow-up work, or rollout notes. -->
33 changes: 33 additions & 0 deletions .github/workflows/broken-link-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Broken Link Check

on:
pull_request:
paths:
- "**/*.md"
- ".github/workflows/broken-link-check.yml"
push:
branches:
- main
paths:
- "**/*.md"
- ".github/workflows/broken-link-check.yml"
schedule:
- cron: "0 12 * * 1"

permissions:
contents: read

jobs:
link-check:
name: Check Markdown Links
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Run Lychee link checker
uses: lycheeverse/lychee-action@v2
with:
args: --verbose --no-progress "**/*.md"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
29 changes: 29 additions & 0 deletions .github/workflows/markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Markdown Lint

on:
pull_request:
paths:
- "**/*.md"
- ".github/workflows/markdown-lint.yml"
push:
branches:
- main
paths:
- "**/*.md"
- ".github/workflows/markdown-lint.yml"

permissions:
contents: read

jobs:
markdown-lint:
name: Lint Markdown
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Run markdownlint-cli2
uses: DavidAnson/markdownlint-cli2-action@v19
with:
globs: "**/*.md"
35 changes: 35 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Spellcheck

on:
pull_request:
paths:
- "**/*.md"
- ".github/workflows/spellcheck.yml"
push:
branches:
- main
paths:
- "**/*.md"
- ".github/workflows/spellcheck.yml"

permissions:
contents: read

jobs:
spellcheck:
name: Check Spelling
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"

- name: Install codespell
run: python -m pip install --upgrade codespell

- name: Run codespell
run: codespell --skip=".git" --ignore-words-list="NTARI,JFA"
25 changes: 25 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Operating system files
.DS_Store
Thumbs.db

# Editor and IDE files
.vscode/
.idea/
*.swp
*.swo

# Logs and temporary files
*.log
*.tmp
*.temp

# Dependency directories and generic build output
node_modules/
dist/
build/
.cache/

# Local environment files
.env
.env.*
!.env.example
9 changes: 9 additions & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Placeholder CODEOWNERS for the NTARI Developer Portal.
# Replace these entries with the appropriate NTARI GitHub teams or maintainers.

* @NTARI-RAND/maintainers
/README.md @NTARI-RAND/docs-maintainers
/CONTRIBUTING.md @NTARI-RAND/docs-maintainers
/CODE_OF_CONDUCT.md @NTARI-RAND/maintainers
/SECURITY.md @NTARI-RAND/maintainers
/LICENSE @NTARI-RAND/maintainers
Loading
Loading