Skip to content

Commit 6511400

Browse files
committed
Update README to remove documentation references
- Remove documentation badge and workflow link - Remove Documentation section with docs site links - Merge Development section into Contributing - Update License link to point to local file - Remove documentation link from Support section
1 parent 9d1c3fe commit 6511400

File tree

1 file changed

+8
-30
lines changed

1 file changed

+8
-30
lines changed

README.md

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# GraphQL SQLCommenter
22

33
[![Tests](https://github.com/lincolnloop/graphql-sqlcommenter/actions/workflows/tests.yml/badge.svg)](https://github.com/lincolnloop/graphql-sqlcommenter/actions/workflows/tests.yml)
4-
[![Documentation](https://github.com/lincolnloop/graphql-sqlcommenter/actions/workflows/docs.yml/badge.svg)](https://lincolnloop.github.io/graphql-sqlcommenter/)
54
[![PyPI version](https://badge.fury.io/py/graphql-sqlcommenter.svg)](https://badge.fury.io/py/graphql-sqlcommenter)
65
[![Python versions](https://img.shields.io/pypi/pyversions/graphql-sqlcommenter.svg)](https://pypi.org/project/graphql-sqlcommenter/)
76
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -88,17 +87,6 @@ SQLCOMMENTER_WITH_SUBSCRIPTIONS = True
8887
SQLCOMMENTER_PATCH_GRAPHQL_CORE = True
8988
```
9089

91-
## Documentation
92-
93-
📖 **[Full Documentation](https://lincolnloop.github.io/graphql-sqlcommenter/)**
94-
95-
- [Quick Start Guide](https://lincolnloop.github.io/graphql-sqlcommenter/getting-started/quickstart/)
96-
- [Installation](https://lincolnloop.github.io/graphql-sqlcommenter/getting-started/installation/)
97-
- [Configuration](https://lincolnloop.github.io/graphql-sqlcommenter/getting-started/configuration/)
98-
- [Implementation Guide](https://lincolnloop.github.io/graphql-sqlcommenter/guides/implementation-guide/)
99-
- [Subscription Support](https://lincolnloop.github.io/graphql-sqlcommenter/guides/subscription-guide/)
100-
- [Examples](https://lincolnloop.github.io/graphql-sqlcommenter/examples/)
101-
10290
## Use Cases
10391

10492
### Track Slow Operations
@@ -123,37 +111,27 @@ graphql_op='listUsers' - 1000 queries (N+1 problem!)
123111
graphql_op='getUserProfile' - 2 queries (optimized)
124112
```
125113

126-
## Development
114+
## Contributing
127115

128-
```bash
129-
# Clone repository
130-
git clone https://github.com/lincolnloop/graphql-sqlcommenter.git
131-
cd graphql-sqlcommenter
116+
Contributions welcome! Please see our issues and discussions.
132117

118+
```bash
133119
# Install with dev dependencies
134-
uv pip install -e ".[dev,docs]"
120+
uv sync --group dev
135121

136122
# Run tests
137-
pytest tests/
138-
139-
# Check types
140-
uv run mypy graphql_sqlcommenter
123+
just test
141124

142-
# Build docs
143-
mkdocs serve
125+
# Run all checks (lint, format, type, tests)
126+
just check
144127
```
145128

146-
## Contributing
147-
148-
Contributions welcome! See [Contributing Guide](https://lincolnloop.github.io/graphql-sqlcommenter/about/contributing/) for details.
149-
150129
## License
151130

152-
Apache 2.0 - See [LICENSE](https://lincolnloop.github.io/graphql-sqlcommenter/about/license/) for details.
131+
Apache 2.0 - See [LICENSE](LICENSE) for details.
153132

154133
## Support
155134

156-
- **Documentation**: https://lincolnloop.github.io/graphql-sqlcommenter/
157135
- **Issues**: https://github.com/lincolnloop/graphql-sqlcommenter/issues
158136
- **Discussions**: https://github.com/lincolnloop/graphql-sqlcommenter/discussions
159137

0 commit comments

Comments
 (0)